API v1 is the programmatic control plane for Salambo workspaces.

​
Base URL

​
Authentication

Keys use:
  • sk_live_ for live mode;
  • sk_test_ for test mode.

​
Primary resources

ResourcePurpose
ModelsDiscover active agent slugs
ResponsesStart, retrieve, stream and cancel agent work
AgentsManage stable agent identity and active state
DeploymentsCreate and inspect immutable agent versions
EnvironmentManage agent configuration and secrets
RunsInspect and control durable execution
FilesList and download authorized files and artifacts
API keysCreate, rotate and revoke scoped authority
Deployment creation captures runtime region, egress, workspace-upgrade, and telemetry policy. Agents do not expose a separate mutable runtime-settings resource.

​
Common execution endpoints

EndpointScopeUse
GET /api/v1/modelsmodels:readList active agent slugs
POST /api/v1/responsesresponses:writeCreate a response
GET /api/v1/responses/{responseId}responses:writeRetrieve a response
POST /api/v1/responses/{responseId}/cancelresponses:writeCancel a response
GET /api/v1/runsruns:readList workspace runs
GET /api/v1/runs/{runId}runs:readInspect a run
POST /api/v1/runs/{runId}/cancelruns:writeStop a run
GET /api/v1/filesfiles:read or responses:writeList files
GET /api/v1/files/{fileId}/contentfiles:read or responses:writeDownload file content

​
Deployment endpoints

EndpointScopeUse
GET /api/v1/agents/{agentId}/deploymentsagents:readList immutable versions
POST /api/v1/agents/{agentId}/deploymentsagents:writeCreate a deployment record
POST /api/v1/agents/{agentId}/deployments/{deploymentId}/manifestagents:writeAttach the compiled manifest
POST /api/v1/agents/{agentId}/deployments/{deploymentId}/sourceagents:writeUpload source and queue the build
POST /api/v1/agents/{agentId}/deployments/{deploymentId}/activateagents:writeExplicitly activate any ready version

​
Environment and key management

EndpointScopeUse
GET /api/v1/agents/{agentId}/env-varsenv_vars:readList environment metadata
PUT /api/v1/agents/{agentId}/env-vars/{name}env_vars:writeStore configuration or a secret
DELETE /api/v1/agents/{agentId}/env-vars/{name}env_vars:writeDelete a value
POST /api/v1/agents/{agentId}/env-vars/{name}/revealenv_vars:revealReveal a secret through an audited path
GET /api/v1/api-keysapi_keys:manageList API keys
POST /api/v1/api-keysapi_keys:manageCreate a key
POST /api/v1/api-keys/{keyId}/rotateapi_keys:manageRotate a key
POST /api/v1/api-keys/{keyId}/revokeapi_keys:manageRevoke a key

​
Error shape

{
  "error": {
    "message": "Missing scope responses:write",
    "type": "permission_error",
    "param": null,
    "code": "permission_denied"
  }
}
Use the generated API Reference for exact schemas, parameters and response objects.