Deployments.ai Docs
Runtime

Submit an asynchronous or client-executed tool result

POST /v1/runs/{runId}/tool-calls/{toolCallId}/results · SDK resolveToolResult · CLI deployments tool-call result

POST
/v1/runs/{runId}/tool-calls/{toolCallId}/results

Requires runs:write.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

runId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
toolCallId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Request Body

application/json
  1. body
externalOperationId?string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length
outcome*string
Value in"completed""failed"
output?
outputSummary?string
Match^\S[\s\S]*\S$|^\S$|^$
Length1 <= length <= 1000
threadId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Response Body

ResolveToolResultResponse

application/json
  1. response
outcome*string
Value in"completed""failed"
run*
toolCall*
curl -X POST "https://example.com/v1/runs/string/tool-calls/string/results" \  -H "Content-Type: application/json" \  -d '{    "outcome": "completed",    "threadId": "string"  }'
{  "outcome": "completed",  "run": {    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "version": 0,    "environmentId": "string",    "organizationId": "string",    "projectId": "string",    "workspaceId": "string",    "agentDeploymentId": "string",    "agentReleaseId": "string",    "attempt": 0,    "automation": {      "fireId": "string",      "id": "string",      "kind": "heartbeat"    },    "checkpointCount": 0,    "completedAt": "2019-08-24T14:15:22Z",    "error": {      "property1": null,      "property2": null    },    "executionBindingId": "string",    "executionPurpose": "customer",    "executor": "string",    "id": "string",    "object": "run",    "parentSpanId": "string",    "priority": 0,    "releaseSelection": "candidate",    "replayedFromRunId": "string",    "replayedFromTraceId": "string",    "spanId": "string",    "startedAt": "2019-08-24T14:15:22Z",    "status": "canceled",    "threadId": "string",    "traceId": "string",    "trigger": "string"  },  "toolCall": {    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "version": 0,    "environmentId": "string",    "organizationId": "string",    "projectId": "string",    "approvalId": "string",    "completedAt": "2019-08-24T14:15:22Z",    "effect": "execute",    "executionType": "client",    "expiresAt": "2019-08-24T14:15:22Z",    "externalOperationId": "string",    "id": "string",    "input": {      "property1": null,      "property2": null    },    "inputSummary": "string",    "modelAttemptId": "string",    "modelCallIndex": 0,    "object": "tool-call",    "output": {      "property1": null,      "property2": null    },    "outputSchema": {      "property1": null,      "property2": null    },    "outputSummary": "string",    "policyAction": "allow",    "policyReason": "string",    "requiredScopes": [      "string"    ],    "runId": "string",    "startedAt": "2019-08-24T14:15:22Z",    "status": "failed",    "toolAdapterId": "string",    "toolName": "string",    "toolPlanFingerprint": "string"  }}