The Responses API is the primary application integration. The model field is an active Salambo agent slug.

Discover agents

curl "$SALAMBO_BASE_URL/api/v1/models" \
  -H "Authorization: Bearer $SALAMBO_API_KEY"
Use a returned id directly as the response model.

Create background work

curl "$SALAMBO_BASE_URL/api/v1/responses" \
  -H "Authorization: Bearer $SALAMBO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "support-agent",
    "input": "Investigate this request and create a report.",
    "background": true,
    "store": true
  }'

Retrieve the response

curl "$SALAMBO_BASE_URL/api/v1/responses/resp_..." \
  -H "Authorization: Bearer $SALAMBO_API_KEY"

Cancel active work

curl -X POST \
  "$SALAMBO_BASE_URL/api/v1/responses/resp_.../cancel" \
  -H "Authorization: Bearer $SALAMBO_API_KEY"
Cancellation stops the response lifecycle. Run cleanup then stops active sandbox work and clears queued follow-up state. Terminal responses cannot be cancelled.

Integration requirements

RequirementCheck
AuthenticationValid account-scoped bearer key
Scopemodels:read and responses:write for the basic flow
AgentActive and owned by the key’s workspace
DeploymentReady active deployment
RuntimeBilling and provider configuration ready

Retry policy

  • Retry bounded network and upstream-unavailable failures.
  • Do not retry authentication or permission failures without changing credentials.
  • Do not retry invalid model or configuration errors without fixing the request or deployment.
  • Use the response identifier to retrieve accepted background work.
  • Cancel abandoned active work instead of deleting a non-terminal run.

Files

Responses can reference downloadable files. Use the Files API with a key that has files:read or the same responses:write authority used for the response workflow. Sandbox-generated files appear only when the agent explicitly publishes them as runtime artifacts. Use the API overview and generated endpoint reference for exact request and response schemas.