On this page
Get a transcript
Read the run’s conversation turns, including available timing and interruption information.
Operation ID: runs.transcript.
Request
GET /api/v1/runs/{run_id}/transcript
- TypeScript SDK:
client.runs.transcript(path arguments usepath). - MCP tool:
sdk_client_callwithoperationId: "runs.transcript"(path arguments useinput.path). Legacy alias:runs_transcript. 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}/transcript" \
-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.transcript({
"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 transcript
application/json
| Field | Type or values | Required | Description and limits |
|---|---|---|---|
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})$. |
state | "complete" · "partial" · "not_available" · "expired" | Required | — |
utterances | array of object | Required | — |
utterances[].index | integer | Required | At least 0. At most 9007199254740991. |
utterances[].role | "agent" · "user" | Required | — |
utterances[].text | string | Required | — |
utterances[].segment_id | string or null | Required | minLength: 1. |
utterances[].observed_offset_ms | integer or null | Required | At least 0. At most 9007199254740991. |
utterances[].interrupted | boolean | Required | — |
utterances[].start_ms | integer or null | Required | At least 0. At most 9007199254740991. |
utterances[].end_ms | integer or null | Required | At least 0. At most 9007199254740991. |
utterances[].node_id | string or null | Required | minLength: 1. |
checkpoint | object or null | Required | — |
checkpoint.segments | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
checkpoint.last_completed_turn_offset_ms | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
checkpoint.published_at | string (date-time) | Required in a non-null parent | 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))$. |
content | object or null | Required | — |
| content · combined section 1 | object | — | Fields for this schema branch. |
content.artifact_id | string (uuid) | Required in a non-null parent | 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})$. |
content.sha256 | string | Required in a non-null parent | pattern: ^[a-f0-9]{64}$. |
content.byte_size | integer | Required in a non-null parent | At least 0. At most 9007199254740991. |
content.media_type | string | Required in a non-null parent | minLength: 1. maxLength: 128. |
content.expires_at | string (date-time) or null | Required in a non-null parent | 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 transcript",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunsTranscriptResponse200"
}
}
}
},
"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": {
"RunsTranscriptResponse200": {
"type": "object",
"properties": {
"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})$"
},
"state": {
"type": "string",
"enum": [
"complete",
"partial",
"not_available",
"expired"
]
},
"utterances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"role": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"text": {
"type": "string"
},
"segment_id": {
"nullable": true,
"type": "string",
"minLength": 1
},
"observed_offset_ms": {
"nullable": true,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"interrupted": {
"type": "boolean"
},
"start_ms": {
"nullable": true,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"end_ms": {
"nullable": true,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"node_id": {
"nullable": true,
"type": "string",
"minLength": 1
}
},
"required": [
"index",
"role",
"text",
"segment_id",
"observed_offset_ms",
"interrupted",
"start_ms",
"end_ms",
"node_id"
],
"additionalProperties": false
}
},
"checkpoint": {
"nullable": true,
"type": "object",
"properties": {
"segments": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"last_completed_turn_offset_ms": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"published_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))$"
}
},
"required": [
"segments",
"last_completed_turn_offset_ms",
"published_at"
],
"additionalProperties": false
},
"content": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ContentRef"
}
]
}
},
"required": [
"run_id",
"state",
"utterances",
"checkpoint",
"content"
],
"additionalProperties": false
},
"ContentRef": {
"type": "object",
"properties": {
"artifact_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})$"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"byte_size": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"media_type": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"expires_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": [
"artifact_id",
"sha256",
"byte_size",
"media_type",
"expires_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.