Read a Run
GET /v1/runs/{run_id}
Property Value Operation get_runGroup Runs Scope integrations:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A Run holds identifiers, statuses, timings and keyed hashes, never content (integrations-operations.md section 1). Released in 1.60.0 Phase 0 host Served (the hosted api pins 1.65.0)
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:read scope (Authentication and keys ). Replace each placeholder, such as agt_... or <name>, with your own value.
cURL Node.js Python
curl "$VOCAL_API/v1/runs/run_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/runs/run_...`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/runs/run_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description run_idpath RunId yes The id of a Run: run_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is Run .
Field Type Required Description arguments_hmacKeyedHash or nullyes attemptsinteger yes binding_sha256Sha256Hex or nullyes breaker_stateBreakerState or nullyes call_idCallId or nullyes connection_idConnectionId yes connector_idConnectorId or nullyes connector_versionstring or null yes contract_sha256Sha256Hex or nullyes created_atTimestamp yes ended_atTimestamp yes environmentEnvironment yes error_codeToolErrorCode or nullyes Null when ok. idRunId yes idempotency_key_hmacKeyedHash or nullyes job_idJobId or nullyes kindRunKind yes mcp_server_idMcpServerId or nullyes message_idMessageId or nullyes mockboolean yes True when the Connector's mock ran instead of the vendor (test). object"run"yes organization_idOrganizationId yes overhead_msinteger yes The exec role's own time, excluding the vendor's, a measurement. queued_msinteger yes rate_limit_wait_msinteger yes request_bytesinteger yes response_bytesinteger yes result_hmacKeyedHash or nullyes retry_causesarray of RetryCause yes Why each retry was sent, such as connect_failed or http_503. started_atTimestamp yes statusRunStatus yes toolUpstreamToolName or nullyes tool_binding_idToolBindingId or nullyes tool_call_idToolCallId or nullyes tool_idToolId or nullyes trigger_event_idTriggerEventId or nullyes vendor_error_codestring or null yes The vendor's error, normalized by the Connector to a snake_case code; never its text. vendor_http_statusinteger or null yes vendor_msarray of AttemptMs yes The vendor time of each attempt, a measurement.