On this page
Get action receipts
Read the run’s action decisions, send attempts and receipts. Check these records when an external action fails or its outcome is uncertain.
Operation ID: runs.effects.
Request
GET /api/v1/runs/{run_id}/effects
- TypeScript SDK:
client.runs.effects(path arguments usepath). - MCP tool:
sdk_client_callwithoperationId: "runs.effects"(path arguments useinput.path). Legacy alias:runs_effects. Connect to your authenticated/mcpendpoint with an API key for the same environment. - Minimum API key role: viewer.
- Idempotency: No idempotency header required.
Read resource IDs from earlier responses and use a key for the same environment.
Request example
Set each path variable to an ID returned by an earlier API request.
Set CUMULUS_BASE_URL to your workspace API URL and CUMULUS_API_KEY to a key for that environment. Example values are synthetic.
cURL
curl --fail-with-body -sS "${CUMULUS_BASE_URL%/}/api/v1/runs/${RUN_ID}/effects" \
-H "Authorization: Bearer $CUMULUS_API_KEY"
TypeScript
import { Cumulus } from "@cumulus/sdk";
const baseUrl = process.env.CUMULUS_BASE_URL;
const apiKey = process.env.CUMULUS_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Set CUMULUS_BASE_URL and CUMULUS_API_KEY");
const client = new Cumulus({ baseUrl, apiKey });
const response = await client.runs.effects({
"path": {
"run_id": "<run_id>"
}
});
Input schema
Path, query and header parameters
run_id
path parameter · Required.
Type: string (uuid). pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$.
JSON request body
This operation has no JSON request body.
Complete OpenAPI schema
{
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
}
],
"requestBody": null
}
Responses
HTTP 200
Read the run's governed effects and receipts
application/json
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
items | array of object | Required | — |
items[].effect_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
items[].run_id | string (uuid) | Required | Run identifier returned when the run was admitted. pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
items[].attempt_id | string (uuid) or null | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
items[].effect_key | string | Required | minLength: 1. maxLength: 256. |
items[].action | object | Required | — |
items[].action.id | string | Required | — |
items[].action.version | integer | Required | Greater than 0. At most 9007199254740991. |
items[].effect_kind | "none" · "transaction" · "gateway_inference" · "http" · "livekit" · "sip_dial" · "sip_transfer" · "sip_hangup" · "run_admission" · "gpu" | Required | — |
items[].node_id | string or null | Required | minLength: 1. maxLength: 128. |
items[].ordinal | integer or null | Required | At least 0. At most 9007199254740991. |
items[].state | "intended" · "sending" · "succeeded" · "failed" · "uncertain" | Required | — |
items[].decision | object or null | Required | — |
items[].decision.decision | "allow" · "deny" · "unavailable" | Required in a non-null parent | — |
items[].decision.reason | string or null | Required in a non-null parent | — |
items[].decision.policy_version | string | Required in a non-null parent | — |
items[].send_attempts | integer | Required | At least 0. At most 9007199254740991. |
items[].receipts | array of object | Required | — |
| items[].receipts[] · variant 1 | object | — | Fields for this schema branch. |
items[].receipts[].kind | "http" | Required | — |
items[].receipts[].status | integer | Required | At least -9007199254740991. At most 9007199254740991. |
items[].receipts[].response_sha256 | string or null | Required | pattern: ^[a-f0-9]{64}$. |
items[].receipts[].response_bytes | integer | Required | At least 0. At most 9007199254740991. |
items[].receipts[].duration_ms | integer | Required | At least -9007199254740991. At most 9007199254740991. |
items[].receipts[].send_attempt | integer | Required | Greater than 0. At most 9007199254740991. |
| items[].receipts[] · variant 2 | object | — | Fields for this schema branch. |
items[].receipts[].kind | "sip_transfer" | Required | — |
items[].receipts[].refer_status | integer or null | Required | At least -9007199254740991. At most 9007199254740991. |
items[].receipts[].final_sip_status | integer or null | Required | At least -9007199254740991. At most 9007199254740991. |
items[].receipts[].disconnect_reason | string or null | Required | — |
| items[].receipts[] · variant 3 | object | — | Fields for this schema branch. |
items[].receipts[].kind | "sip_dial" | Required | — |
items[].receipts[].participant_id | string | Required | — |
items[].receipts[].sip_call_id | string or null | Required | — |
| items[].receipts[] · variant 4 | object | — | Fields for this schema branch. |
items[].receipts[].kind | "livekit" | Required | — |
items[].receipts[].resource_id | string | Required | — |
| items[].receipts[] · variant 5 | object | — | Fields for this schema branch. |
items[].receipts[].kind | "gateway_inference" | Required | — |
items[].receipts[].attempt_id | string (uuid) | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
items[].receipts[].measurement_id | string (uuid) or null | Required | pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$. |
| items[].receipts[] · variant 6 | object | — | Fields for this schema branch. |
items[].receipts[].kind | "transaction" | Required | — |
items[].receipts[].table | string | Required | — |
items[].receipts[].row_id | string | Required | — |
items[].error_code | string or null | Required | — |
items[].created_at | string (date-time) | Required | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z))$. |
items[].settled_at | string (date-time) or null | Required | pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z))$. |
Error responses
| HTTP | Description |
|---|---|
| 4XX | Typed error (ApiError) |
| 5XX | Typed error (ApiError) |
Errors use the shared error envelope. Inspect error.code, retryable, outcome and details before retrying.
Complete OpenAPI schema
{
"200": {
"description": "Read the run's governed effects and receipts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunsEffectsResponse200"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
Expand the complete OpenAPI definitions for integrations that generate their own clients.
Complete OpenAPI schema
{
"components": {
"schemas": {
"RunsEffectsResponse200": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EffectRecord"
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
"EffectRecord": {
"type": "object",
"properties": {
"effect_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"run_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"attempt_id": {
"nullable": true,
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"effect_key": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"action": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
}
},
"required": [
"id",
"version"
],
"additionalProperties": false
},
"effect_kind": {
"type": "string",
"enum": [
"none",
"transaction",
"gateway_inference",
"http",
"livekit",
"sip_dial",
"sip_transfer",
"sip_hangup",
"run_admission",
"gpu"
]
},
"node_id": {
"nullable": true,
"type": "string",
"minLength": 1,
"maxLength": 128
},
"ordinal": {
"nullable": true,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"intended",
"sending",
"succeeded",
"failed",
"uncertain"
]
},
"decision": {
"nullable": true,
"type": "object",
"properties": {
"decision": {
"type": "string",
"enum": [
"allow",
"deny",
"unavailable"
]
},
"reason": {
"nullable": true,
"type": "string"
},
"policy_version": {
"type": "string"
}
},
"required": [
"decision",
"reason",
"policy_version"
],
"additionalProperties": false
},
"send_attempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"receipts": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"http"
]
},
"status": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"response_sha256": {
"nullable": true,
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"response_bytes": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"duration_ms": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"send_attempt": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9007199254740991
}
},
"required": [
"kind",
"status",
"response_sha256",
"response_bytes",
"duration_ms",
"send_attempt"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"sip_transfer"
]
},
"refer_status": {
"nullable": true,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"final_sip_status": {
"nullable": true,
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"disconnect_reason": {
"nullable": true,
"type": "string"
}
},
"required": [
"kind",
"refer_status",
"final_sip_status",
"disconnect_reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"sip_dial"
]
},
"participant_id": {
"type": "string"
},
"sip_call_id": {
"nullable": true,
"type": "string"
}
},
"required": [
"kind",
"participant_id",
"sip_call_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"livekit"
]
},
"resource_id": {
"type": "string"
}
},
"required": [
"kind",
"resource_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"gateway_inference"
]
},
"attempt_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"measurement_id": {
"nullable": true,
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
}
},
"required": [
"kind",
"attempt_id",
"measurement_id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"transaction"
]
},
"table": {
"type": "string"
},
"row_id": {
"type": "string"
}
},
"required": [
"kind",
"table",
"row_id"
],
"additionalProperties": false
}
]
}
},
"error_code": {
"nullable": true,
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"settled_at": {
"nullable": true,
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
}
},
"required": [
"effect_id",
"run_id",
"attempt_id",
"effect_key",
"action",
"effect_kind",
"node_id",
"ordinal",
"state",
"decision",
"send_attempts",
"receipts",
"error_code",
"created_at",
"settled_at"
],
"additionalProperties": false
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.