Deployments.ai Docs

API reference

Every public API operation, grouped by area.

The public API has 470 operations. Each page shows the request and response schemas, the authentication it takes, and curl, SDK, and CLI samples.

Agent Email

OperationEndpoint
Approve an email draftPOST /v1/agent-email/drafts/{draftId}/approve
Bind an inbox to an agent deployment or external targetPOST /v1/agent-email/inboxes/{inboxId}/bindings
Cancel an email draftPOST /v1/agent-email/drafts/{draftId}/cancel
Create a raw message access URLPOST /v1/agent-email/messages/{messageId}/raw/access
Create an agent email inboxPOST /v1/agent-email/inboxes
Create an attachment access URLPOST /v1/agent-email/attachments/{attachmentId}/access-url
Create an email draftPOST /v1/agent-email/inboxes/{inboxId}/drafts
Create an email placementPOST /v1/agent-email/placements
Create an email suppressionPOST /v1/agent-email/suppressions
Delete an inbox bindingDELETE /v1/agent-email/bindings/{bindingId}
Export agent email usagePOST /v1/agent-email/usage/export
Forward an email messagePOST /v1/agent-email/messages/{messageId}/forward
List agent email inboxesGET /v1/agent-email/inboxes
List email domainsGET /v1/agent-email/domains
List email placementsGET /v1/agent-email/placements
List email suppressionsGET /v1/agent-email/suppressions
List inbox bindingsGET /v1/agent-email/inboxes/{inboxId}/bindings
List inbox draftsGET /v1/agent-email/inboxes/{inboxId}/drafts
List inbox messagesGET /v1/agent-email/inboxes/{inboxId}/messages
List inbox threadsGET /v1/agent-email/inboxes/{inboxId}/threads
Refresh email domain verificationPOST /v1/agent-email/domains/{domainId}/refresh
Register a custom email domainPOST /v1/agent-email/domains
Reject an email draftPOST /v1/agent-email/drafts/{draftId}/reject
Remove an email suppressionPOST /v1/agent-email/suppressions/{suppressionId}/remove
Reply all to an email messagePOST /v1/agent-email/messages/{messageId}/reply-all
Reply to an email messagePOST /v1/agent-email/messages/{messageId}/reply
Reprocess a raw inbound messagePOST /v1/agent-email/messages/{messageId}/raw/reprocess
Revoke a custom email domainPOST /v1/agent-email/domains/{domainId}/revoke
Search inbox messagesPOST /v1/agent-email/inboxes/{inboxId}/messages/search
Search inbox threadsPOST /v1/agent-email/inboxes/{inboxId}/threads/search
Send an agent email messagePOST /v1/agent-email/inboxes/{inboxId}/messages
Send an approved email draftPOST /v1/agent-email/drafts/{draftId}/send
Show agent email usageGET /v1/agent-email/usage
Show an agent email inboxGET /v1/agent-email/inboxes/{inboxId}
Show an email draftGET /v1/agent-email/drafts/{draftId}
Show an email messageGET /v1/agent-email/messages/{messageId}
Show an email placementGET /v1/agent-email/placements/{placementId}
Show an email thread and its messagesGET /v1/agent-email/inboxes/{inboxId}/threads/{threadId}
Show an inbox bindingGET /v1/agent-email/bindings/{bindingId}
Show DNS and verification stateGET /v1/agent-email/domains/{domainId}
Show the email policyGET /v1/agent-email/policy
Submit an email draft for approvalPOST /v1/agent-email/drafts/{draftId}/submit
Update an agent email inboxPATCH /v1/agent-email/inboxes/{inboxId}
Update an email draftPATCH /v1/agent-email/drafts/{draftId}
Update an email placementPATCH /v1/agent-email/placements/{placementId}
Update the email policyPATCH /v1/agent-email/policy

Agents

OperationEndpoint
Abort the active canaryPOST /v1/agent-deployments/{id}/canary/abort
Archive an agent definitionDELETE /v1/agent-definitions/{id}
Archive an agent releaseDELETE /v1/agent-releases/{id}
Create an agent definitionPOST /v1/agent-definitions
Create an immutable agent releasePOST /v1/agent-definitions/{id}/releases
Deploy an agent releasePOST /v1/agent-deployments
List agent definitionsGET /v1/agent-definitions
List agent deploymentsGET /v1/agent-deployments
List releases for an agent definitionGET /v1/agent-definitions/{id}/releases
Pause an agent deploymentPATCH /v1/agent-deployments/{id}
Promote an agent release into another environmentPOST /v1/agent-releases/{id}/promote
Promote the canary candidate to primaryPOST /v1/agent-deployments/{id}/canary/promote
Show an agent definitionGET /v1/agent-definitions/{id}
Show an agent deploymentGET /v1/agent-deployments/{id}
Show an agent releaseGET /v1/agent-releases/{id}
Start a canary for a candidate agent releasePOST /v1/agent-deployments/{id}/canary
Stop an agent deploymentDELETE /v1/agent-deployments/{id}
Update an agent definitionPATCH /v1/agent-definitions/{id}

Alerts

OperationEndpoint
Archive a monitorDELETE /v1/monitors/{id}
Change, mute, or unmute a monitorPATCH /v1/monitors/{id}
Create a monitorPOST /v1/monitors
List alert incidents, newest firstGET /v1/alert-incidents
List monitorsGET /v1/monitors
Send a test alert to yourself and the monitor's webhooksPOST /v1/monitors/{id}/test
Show a monitorGET /v1/monitors/{id}
Show one alert incident with its timelineGET /v1/monitors/{id}/incidents/{incidentId}
Show your alert email settingsGET /v1/alert-notification-preferences
Turn your alert emails on or off, or mute monitorsPUT /v1/alert-notification-preferences

Apps

Artifacts

OperationEndpoint
Create a customer artifact uploadPOST /v1/artifacts
Create a scoped artifact access URLPOST /v1/artifacts/{artifactId}/access-urls
Delete an artifact and erase its stored bytesDELETE /v1/artifacts/{artifactId}
List artifactsGET /v1/artifacts
Set or clear artifact retentionPATCH /v1/artifacts/{artifactId}/retention
Show artifact metadataGET /v1/artifacts/{artifactId}
Verify and complete a customer artifact uploadPOST /v1/artifacts/{artifactId}/complete

Automations

OperationEndpoint
Archive a heartbeatDELETE /v1/heartbeats/{heartbeatId}
Archive a scheduleDELETE /v1/schedules/{scheduleId}
Create a heartbeatPOST /v1/heartbeats
Create a schedulePOST /v1/schedules
Fire a heartbeat nowPOST /v1/heartbeats/{heartbeatId}/fire
Fire a schedule nowPOST /v1/schedules/{scheduleId}/fire
List heartbeat fire historyGET /v1/heartbeats/{heartbeatId}/fires
List heartbeatsGET /v1/heartbeats
List schedule fire historyGET /v1/schedules/{scheduleId}/fires
List schedulesGET /v1/schedules
Pause a heartbeatPOST /v1/heartbeats/{heartbeatId}/pause
Pause a schedulePOST /v1/schedules/{scheduleId}/pause
Resume a heartbeatPOST /v1/heartbeats/{heartbeatId}/resume
Resume a schedulePOST /v1/schedules/{scheduleId}/resume
Show a heartbeatGET /v1/heartbeats/{heartbeatId}
Show a scheduleGET /v1/schedules/{scheduleId}
Update a heartbeatPATCH /v1/heartbeats/{heartbeatId}
Update a schedulePATCH /v1/schedules/{scheduleId}

Brains

OperationEndpoint
Archive a BrainDELETE /v1/brains/{brainId}
Ask a cited question across authorized BrainsPOST /v1/brains/ask
Capture a Brain document revisionPOST /v1/brains/{brainId}/sources/{sourceId}/documents
Complete a ticket whose content was stored through its direct uploadPOST /v1/brains/{brainId}/sources/{sourceId}/uploads/{ticketId}/complete
Create a BrainPOST /v1/brains
Create a Brain grantPOST /v1/brains/{brainId}/grants
Create a Brain sourcePOST /v1/brains/{brainId}/sources
Issue a Brain upload ticketPOST /v1/brains/{brainId}/sources/{sourceId}/uploads
List Brain document index healthGET /v1/brains/{brainId}/index-health
List Brain grantsGET /v1/brains/{brainId}/grants
List Brain mountsGET /v1/brains/{brainId}/mounts
List Brain sourcesGET /v1/brains/{brainId}/sources
List open Brain review itemsGET /v1/brains/{brainId}/review-items
List visible BrainsGET /v1/brains
Mount a Brain on an agent deploymentPOST /v1/brains/{brainId}/mounts
Permanently erase a Brain and its derived dataPOST /v1/brains/{brainId}/erasures
Record usefulness feedback for a Brain queryPOST /v1/brains/query-attempts/{queryAttemptId}/feedback
Resolve a Brain review itemPOST /v1/brains/{brainId}/review-items/{reviewItemId}/resolve
Revoke a Brain grantDELETE /v1/brains/{brainId}/grants/{grantId}
Revoke a Brain mountDELETE /v1/brains/{brainId}/mounts/{mountId}
Search source-grounded Brain evidencePOST /v1/brains/search
Show a BrainGET /v1/brains/{brainId}
Show a Brain document and current immutable versionGET /v1/brains/{brainId}/documents/{documentId}
Show a Brain entity with bounded cited relationshipsGET /v1/brains/{brainId}/entities/{entityId}
Show a Brain erasure receiptGET /v1/brains/{brainId}/erasures/{erasureId}
Show a Brain upload ticketGET /v1/brains/{brainId}/sources/{sourceId}/uploads/{ticketId}
Update a BrainPATCH /v1/brains/{brainId}
Upload exact Brain ticket contentPUT /v1/brains/{brainId}/sources/{sourceId}/uploads/{ticketId}/content

Budgets

OperationEndpoint
Archive a spend budgetDELETE /v1/budgets/{id}
Create a spend budgetPOST /v1/budgets
List a budget's periods with spendGET /v1/budgets/{id}/periods
List spend budgetsGET /v1/budgets
Rename, resize, pause, or resume a spend budgetPATCH /v1/budgets/{id}
Show a spend budgetGET /v1/budgets/{id}

Email

OperationEndpoint
Create a sending tenantPOST /v1/email/tenants
Get a sending tenantGET /v1/email/tenants/{tenantId}
Get sending domain DNS and verification stateGET /v1/email/domains/{domainId}
List a tenant's sending domainsGET /v1/email/tenants/{tenantId}/domains
List sending tenantsGET /v1/email/tenants
Refresh sending domain ownership and DNS verificationPOST /v1/email/domains/{domainId}/refresh
Register a sending domain ownership challengePOST /v1/email/tenants/{tenantId}/domains
Revoke a sending domainDELETE /v1/email/domains/{domainId}
Send email and return the provider acceptance receiptPOST /v1/email/tenants/{tenantId}/messages
Update or explicitly pause/reinstate a sending tenantPATCH /v1/email/tenants/{tenantId}

Evaluations

OperationEndpoint
Add one case from inline input or an existing run or tracePOST /v1/regression-datasets/{datasetId}/cases
Annotate a tracePOST /v1/traces/{traceId}/annotations
Archive a regression datasetPOST /v1/regression-datasets/{datasetId}/archive
Archive a score definitionPOST /v1/score-definitions/{scoreDefinitionId}/archive
Compare a candidate release against a baseline on a datasetPOST /v1/release-comparisons
Create a regression datasetPOST /v1/regression-datasets
Create a score definitionPOST /v1/score-definitions
Import cases from a JSON case filePOST /v1/regression-datasets/{datasetId}/cases/import
List annotations for a traceGET /v1/traces/{traceId}/annotations
List cases in a regression datasetGET /v1/regression-datasets/{datasetId}/cases
List evaluation runs, newest firstGET /v1/evaluation-runs
List per-case results of an evaluation runGET /v1/evaluation-runs/{evaluationRunId}/results
List recent score resultsGET /v1/score-results
List regression datasetsGET /v1/regression-datasets
List release comparisons, newest firstGET /v1/release-comparisons
List score definitionsGET /v1/score-definitions
List score results for a traceGET /v1/traces/{traceId}/score-results
Publish a new score definition revisionPOST /v1/score-definitions/{scoreDefinitionId}/revisions
Record a human or imported score for a tracePOST /v1/traces/{traceId}/score-results
Show a regression datasetGET /v1/regression-datasets/{datasetId}
Show a release comparison and its verdictGET /v1/release-comparisons/{releaseComparisonId}
Show a score definitionGET /v1/score-definitions/{scoreDefinitionId}
Show an evaluation run and its summaryGET /v1/evaluation-runs/{evaluationRunId}
Start a dataset replay or trace scoring runPOST /v1/evaluation-runs

Extensions

OperationEndpoint
Archive an extension toolDELETE /v1/extensions/{toolName}
Archive an MCP serverDELETE /v1/mcp-servers/{id}
Create an MCP connectionPOST /v1/mcp-connections
List extension toolsGET /v1/extensions
List MCP connectionsGET /v1/mcp-connections
List MCP serversGET /v1/mcp-servers
Register an extension toolPOST /v1/extensions
Register an MCP serverPOST /v1/mcp-servers
Revoke an MCP connectionDELETE /v1/mcp-connections/{id}
Show a hosted code tool artifactGET /v1/hosted-code-artifacts/{contentHash}
Show an extension toolGET /v1/extensions/{toolName}
Show an MCP connectionGET /v1/mcp-connections/{id}
Show an MCP serverGET /v1/mcp-servers/{id}
Update an extension toolPATCH /v1/extensions/{toolName}
Update an MCP serverPATCH /v1/mcp-servers/{id}
Upload hosted code tool sourcePOST /v1/hosted-code-artifacts
Verify and discover MCP toolsPOST /v1/mcp-servers/{id}/discover

Governance

OperationEndpoint
Create a tenant data exportPOST /v1/organizations/{id}/data-exports
Create an immutable audit exportPOST /v1/organizations/{id}/audit-exports
Erase tenant dataPOST /v1/organizations/{id}/erasures
List governance operation history, newest firstGET /v1/organizations/{id}/governance-operations
Replace an organization's egress allowlistPUT /v1/organizations/{id}/egress-allowlist
Show a tenant data export operationGET /v1/organizations/{id}/data-exports/{operationId}
Show a tenant erasure operationGET /v1/organizations/{id}/erasures/{operationId}
Show an immutable audit export operationGET /v1/organizations/{id}/audit-exports/{operationId}
Show an organization retention policyGET /v1/organizations/{id}/retention-policy
Show an organization's egress allowlistGET /v1/organizations/{id}/egress-allowlist
Update an organization retention policyPATCH /v1/organizations/{id}/retention-policy

Managed Skills

OperationEndpoint
Archive a managed skill releaseDELETE /v1/managed-skill-releases/{id}
Archive a managed skill sourceDELETE /v1/managed-skill-sources/{id}
Create a managed skill sourcePOST /v1/managed-skill-sources
Inspect a managed skillGET /v1/managed-skills/{id}
Inspect skills in a managed skill releaseGET /v1/managed-skill-releases/{id}/skills
Install a managed skillPOST /v1/managed-skill-installations
List managed skill installationsGET /v1/managed-skill-installations
List managed skill sourcesGET /v1/managed-skill-sources
List releases for a managed skill sourceGET /v1/managed-skill-sources/{id}/releases
Publish materialized managed skill contentPOST /v1/managed-skill-sources/{id}/releases
Remove a managed skill installationDELETE /v1/managed-skill-installations/{id}
Show a managed skill installationGET /v1/managed-skill-installations/{id}
Show a managed skill releaseGET /v1/managed-skill-releases/{id}
Show a managed skill sourceGET /v1/managed-skill-sources/{id}
Update a managed skill sourcePATCH /v1/managed-skill-sources/{id}

Memory

OperationEndpoint
Archive a memory spaceDELETE /v1/memory-spaces/{memorySpaceId}
Archive memoryPOST /v1/memory/{memoryId}/archive
Change a memory space grant permissionPATCH /v1/memory-space-grants/{grantId}
Create a memory policyPOST /v1/memory/policies
Create a memory spacePOST /v1/memory-spaces
Create or update a memory policyPUT /v1/memory/policies
Delete memoryPOST /v1/memory/{memoryId}/delete
Export governed memoryPOST /v1/memory/exports
Grant an agent access to a memory spacePOST /v1/memory-space-grants
Import governed memoryPOST /v1/memory/imports
Inspect memory retrieval qualityGET /v1/memory/quality
Inspect memory search namespace readinessGET /v1/memory/namespaces/readiness
List governed memoryGET /v1/memory
List memory policiesGET /v1/memory/policies
List memory review itemsGET /v1/memory/review-items
List memory space grantsGET /v1/memory-space-grants
List memory spacesGET /v1/memory-spaces
Prepare the memory search full-text indexPOST /v1/memory/namespaces/prepare-full-text
Queue post-run memory extractionPOST /v1/memory/flushes
Recall memory for an active runPOST /v1/memory/active-recall
Record retrieval usefulness feedbackPOST /v1/memory/{memoryId}/retrievals/{retrievalId}/feedback
Resolve a memory review itemPOST /v1/memory/{memoryId}/review-items/{reviewId}
Restore memoryPOST /v1/memory/{memoryId}/restore
Revoke a memory space grantDELETE /v1/memory-space-grants/{grantId}
Search approved memoryPOST /v1/memory/search
Search memory with an evidence retrieval strategyPOST /v1/memory/evidence/strategy-search
Show a memory spaceGET /v1/memory-spaces/{memorySpaceId}
Show post-run memory extraction statusGET /v1/memory/flushes/{runId}

Models

OperationEndpoint
Archive a model policyDELETE /v1/model-policies/{id}
Create the environment model policyPOST /v1/model-policies
List catalog models and whether this environment allows themGET /v1/models
List model policiesGET /v1/model-policies
List the organization's model provider keys; keys are shown by last four onlyGET /v1/organizations/{id}/model-credentials
Remove a model provider key; its metadata stays for auditDELETE /v1/organizations/{id}/model-credentials/{provider}
Show a model policyGET /v1/model-policies/{id}
Show one model provider key without revealing itGET /v1/organizations/{id}/model-credentials/{provider}
Update a model policyPATCH /v1/model-policies/{id}
Verify a provider key with the provider, then store or replace itPUT /v1/organizations/{id}/model-credentials/{provider}

Observability

OperationEndpoint
Export a bounded recent trace setPOST /v1/observability/exports
List and filter recent tracesGET /v1/observability/traces
List traces for a sessionGET /v1/observability/sessions/{sessionId}/traces
Render the spans in an execution traceGET /v1/observability/traces/{traceId}/spans
Show a finalized traceGET /v1/observability/traces/{traceId}
Show the trace containing a runGET /v1/observability/runs/{runId}/trace
Show tool calls, errors, and latencyGET /v1/observability/tools
Show trace or model metrics by time bucket, optionally groupedGET /v1/observability/metrics

Operations

OperationEndpoint
List API-key request activityGET /v1/api-key-usage
List audit eventsGET /v1/audit-events
List organization-level audit eventsGET /v1/organizations/{id}/audit-events
Show an audit eventGET /v1/audit-events/{id}
Show cost recordsGET /v1/costs
Show spend aggregatesGET /v1/spend
Show usage aggregatesGET /v1/usage
Summarize cost per metric and hour or dayGET /v1/costs/summary
Summarize usage per metric and hour or dayGET /v1/usage/summary

Providers

OperationEndpoint
Archive an OAuth applicationDELETE /v1/oauth-apps/{id}
Grant a connection to an agentPOST /v1/connection-grants
List connection capabilitiesGET /v1/connections/{id}/capabilities
List connection grantsGET /v1/connection-grants
List OAuth applicationsGET /v1/oauth-apps
List provider connectionsGET /v1/connections
List provider credentialsGET /v1/credentials
List supported providersGET /v1/providers
Register a static provider credentialPOST /v1/credentials
Register an OAuth applicationPOST /v1/oauth-apps
Revoke a connection grantDELETE /v1/connection-grants/{id}
Revoke a provider connectionDELETE /v1/connections/{id}
Revoke a provider credentialDELETE /v1/credentials/{id}
Rotate a provider credentialPOST /v1/credentials/{id}/rotate
Rotate an OAuth client secretPOST /v1/oauth-apps/{id}/rotate
Show a connection grantGET /v1/connection-grants/{id}
Show a connection verificationGET /v1/connection-verifications/{id}
Show a provider connectionGET /v1/connections/{id}
Show an OAuth applicationGET /v1/oauth-apps/{id}
Show provider capabilitiesGET /v1/providers/{providerKey}
Start provider authorizationPOST /v1/connections
Sync vendor MCP tools for a provider connectionPOST /v1/connections/{connectionId}/tools/sync
Verify a provider connectionPOST /v1/connections/{id}/verify

Runtime

OperationEndpoint
Approve a pending tool callPOST /v1/runs/{runId}/approvals/{approvalId}/resolve
Archive a channel bindingDELETE /v1/channel-bindings/{bindingId}
Archive a conversation threadPOST /v1/threads/{threadId}/archive
Archive a webhook subscriptionPOST /v1/webhooks/{webhookId}/archive
Attach or rotate a channel runtime credential and disable the binding until verificationPUT /v1/channel-bindings/{bindingId}/credential
Cancel an agent runPOST /v1/runs/{runId}/cancel
Compose an outbound channel deliveryPOST /v1/channel-bindings/{bindingId}/deliveries
Create a bounded thread stream sessionPOST /v1/threads/{threadId}/stream-sessions
Create a channel bindingPOST /v1/channel-bindings
Create a conversation threadPOST /v1/threads
Create a preview from an unpublished agent manifestPOST /v1/previews
Create a webhook subscriptionPOST /v1/webhooks
Create an agent runPOST /v1/agent-deployments/{agentDeploymentId}/runs
Expire a previewDELETE /v1/previews/{previewId}
List agent runs in the environment, optionally for one deployment or bindingGET /v1/runs
List approval requestsGET /v1/approvals
List channel bindingsGET /v1/channel-bindings
List channel deliveriesGET /v1/channel-deliveries
List conversation threadsGET /v1/threads
List the attempts of a webhook deliveryGET /v1/webhook-deliveries/{deliveryId}/attempts
List thread messagesGET /v1/threads/{threadId}/messages
List tool calls for a run (client tools show executionType, input, expiresAt)GET /v1/runs/{runId}/tool-calls
List webhook deliveriesGET /v1/webhook-deliveries
List webhook subscriptionsGET /v1/webhooks
List what the runtime logged while executing a runGET /v1/runs/{runId}/logs
Pause deliveries to a webhook subscriptionPOST /v1/webhooks/{webhookId}/disable
Permanently erase a thread and everything derived from itPOST /v1/threads/{threadId}/erasures
Permanently erase every thread of one end user in the environmentPOST /v1/end-users/erasures
Publish a confirmed externally delivered automation messagePOST /v1/threads/{threadId}/runs/{runId}/message/publications
Release an uncertain external automation delivery reservationPOST /v1/threads/{threadId}/runs/{runId}/message/publication-releases
Replay an agent runPOST /v1/runs/{runId}/replay
Reserve conversation order before an external automation deliveryPOST /v1/threads/{threadId}/runs/{runId}/message/publication-reservations
Resume deliveries to a webhook subscriptionPOST /v1/webhooks/{webhookId}/enable
Retry a delivered or failed webhook deliveryPOST /v1/webhook-deliveries/{deliveryId}/retry
Retry a failed agent runPOST /v1/runs/{runId}/retry
Revoke a channel runtime credential and disable its bindingDELETE /v1/channel-bindings/{bindingId}/credential
Rotate a webhook signing secretPOST /v1/webhooks/{webhookId}/rotate-secret
Search agent runsPOST /v1/runs/search
Send a signed test event to a webhook subscriptionPOST /v1/webhooks/{webhookId}/test
Show a channel bindingGET /v1/channel-bindings/{bindingId}
Show a channel deliveryGET /v1/runs/{runId}/channel-deliveries/{deliveryId}
Show a previewGET /v1/previews/{previewId}
Show a run by ID without its threadGET /v1/runs/{runId}
Show a run within its threadGET /v1/threads/{threadId}/runs/{runId}
Show a threadGET /v1/threads/{threadId}
Show a thread erasureGET /v1/threads/{threadId}/erasures/{erasureId}
Show a webhook deliveryGET /v1/webhook-deliveries/{deliveryId}
Show a webhook subscriptionGET /v1/webhooks/{webhookId}
Show an approval requestGET /v1/runs/{runId}/approvals/{approvalId}
Show an end-user erasureGET /v1/end-users/erasures/{erasureId}
Show callback dispatch evidenceGET /v1/callback-dispatch-evidence/{evidenceId}
Show the finalized assistant message for a runGET /v1/threads/{threadId}/runs/{runId}/message
Submit a turn to a previewPOST /v1/previews/{previewId}/turns
Submit an asynchronous or client-executed tool resultPOST /v1/runs/{runId}/tool-calls/{toolCallId}/results
Tail a run timelineGET /v1/threads/{threadId}/stream
Update a channel bindingPATCH /v1/channel-bindings/{bindingId}
Update a webhook subscriptionPATCH /v1/webhooks/{webhookId}
Verify a channel bindingPOST /v1/channel-bindings/{bindingId}/verify

Security

System

OperationEndpoint
Close your operator access to an organizationDELETE /v1/system/organizations/{organizationId}/operator-access
Disable a person, which ends their sessions, or re-enable themPUT /v1/system/principals/{principalId}/status
End every session, refresh token, and device grant without disabling the personPOST /v1/system/principals/{principalId}/sessions/revoke
Find the person or pending sign-up holding an email; matches the whole addressGET /v1/system/principals
Get healthGET /health
Limit where an organization's data can go; only operators can set itPUT /v1/system/organizations/{organizationId}/data-boundary
List a person's security events, newest first; secret fields are withheldGET /v1/system/principals/{principalId}/security-events
List an organization's hold and grant changes, newest firstGET /v1/system/organizations/{organizationId}/standing/history
List every organization in the installGET /v1/system/organizations
List open operator access across the installGET /v1/system/operator-access
List recorded deployments, newest firstGET /v1/system/deployments
List the install's CloudWatch alarmsGET /v1/system/alarms
Open or renew your operator access to an organization's dataPUT /v1/system/organizations/{organizationId}/operator-access
Place an operator hold on an organizationPUT /v1/system/organizations/{organizationId}/holds/{holdKey}
Release an operator hold on an organizationDELETE /v1/system/organizations/{organizationId}/holds/{holdKey}
Remove an organization's data boundaryDELETE /v1/system/organizations/{organizationId}/data-boundary
Remove the operator's entitlement grantDELETE /v1/system/organizations/{organizationId}/entitlements
Replace the operator's entitlement grant; omitted fields fall to other sourcesPUT /v1/system/organizations/{organizationId}/entitlements
Resend a pending sign-up's verification email, under the self-service limitsPOST /v1/system/principals/{principalId}/verification-email
Show a person's organizations, multi-factor state, and session countsGET /v1/system/principals/{principalId}
Show an organization's holds, grants, data boundary, and effective entitlementsGET /v1/system/organizations/{organizationId}/standing
Show an organization's spend in a month, split by who paidGET /v1/system/organizations/{organizationId}/spend
Show ECS service and Lambda function health for the installGET /v1/system/components
Show model provider key metadataGET /v1/system/model-providers
Show the deployed release, account, endpoints, and observability data locationsGET /v1/system/installation
Show your operator access to an organizationGET /v1/system/organizations/{organizationId}/operator-access

Tenancy

OperationEndpoint
Accept an invitationPOST /v1/invitations/{id}/accept
Add an organization memberPOST /v1/members
Archive a projectDELETE /v1/projects/{id}
Archive a workspaceDELETE /v1/workspaces/{id}
Archive an environmentDELETE /v1/environments/{id}
Create a projectPOST /v1/projects
Create a service accountPOST /v1/service-accounts
Create a workspacePOST /v1/workspaces
Create an API keyPOST /v1/api-keys
Create an environmentPOST /v1/environments
Create an invitationPOST /v1/invitations
Create an organizationPOST /v1/organizations
List API keysGET /v1/api-keys
List environmentsGET /v1/environments
List organization membersGET /v1/members
List organizationsGET /v1/organizations
List pending invitationsGET /v1/invitations
List projectsGET /v1/projects
List service accountsGET /v1/service-accounts
List workspacesGET /v1/workspaces
Remove an organization memberDELETE /v1/members/{id}
Revoke a service accountDELETE /v1/service-accounts/{id}
Revoke an API keyDELETE /v1/api-keys/{id}
Revoke an invitationDELETE /v1/invitations/{id}
Rotate an API keyPOST /v1/api-keys/{id}/rotate
Show a month's spend for each project, split into operator-funded and organization-fundedGET /v1/organizations/{id}/spend/projects
Show a month's spend split into operator-funded and organization-funded, with the operator-funded ceilingGET /v1/organizations/{id}/spend
Show a projectGET /v1/projects/{id}
Show a service accountGET /v1/service-accounts/{id}
Show a workspaceGET /v1/workspaces/{id}
Show a workspace's spend for a month, split into operator-funded and organization-fundedGET /v1/workspaces/{id}/spend
Show an environmentGET /v1/environments/{id}
Show an organizationGET /v1/organizations/{id}
Show the request rate, concurrent run, and sandbox limits the organization runs underGET /v1/organizations/{id}/limits
Show whether the organization is suspended, why, and the limits and model spend ceiling it runs underGET /v1/organizations/{id}/standing
Update a member rolePATCH /v1/members/{id}
Update a projectPATCH /v1/projects/{id}
Update a workspacePATCH /v1/workspaces/{id}
Update an environmentPATCH /v1/environments/{id}
Update an organizationPATCH /v1/organizations/{id}

Tools

OperationEndpoint
Archive a tool policyDELETE /v1/tool-policies/{id}
Create a tool policyPOST /v1/tool-policies
List code-owned platform tools with their default policyGET /v1/tools
List tool policiesGET /v1/tool-policies
Show a platform tool with its input schemaGET /v1/tools/{toolName}
Show a tool policyGET /v1/tool-policies/{id}
Show what a tool policy or an agent deployment's pinned policies decide for tools (no side effects)POST /v1/tool-policies/evaluate
Update a tool policyPATCH /v1/tool-policies/{id}

Workflows

OperationEndpoint
Approve a pending workflow stepPOST /v1/workflow-executions/{workflowExecutionId}/approvals/{workflowApprovalId}/resolve
Archive a workflow definitionDELETE /v1/workflow-definitions/{id}
Archive a workflow releaseDELETE /v1/workflow-releases/{id}
Create a workflow definitionPOST /v1/workflow-definitions
List releases for a workflow definitionGET /v1/workflow-definitions/{id}/releases
List workflow definitionsGET /v1/workflow-definitions
List workflow executionsGET /v1/workflow-executions
List workflow step attemptsGET /v1/workflow-executions/{workflowExecutionId}/steps
Publish an immutable workflow releasePOST /v1/workflow-definitions/{id}/releases
Request workflow execution cancellationPOST /v1/workflow-executions/{workflowExecutionId}/cancel
Show a workflow approvalGET /v1/workflow-executions/{workflowExecutionId}/approvals/{workflowApprovalId}
Show a workflow definitionGET /v1/workflow-definitions/{id}
Show a workflow executionGET /v1/workflow-executions/{workflowExecutionId}
Show a workflow releaseGET /v1/workflow-releases/{id}
Start an immutable workflow releasePOST /v1/workflow-releases/{workflowReleaseId}/executions
Update a workflow definitionPATCH /v1/workflow-definitions/{id}

On this page