Skip to navigation

Retrieve transcripts for specific calls

View as Markdown

Returns transcripts (and optionally AI summaries) for up to 100 call IDs. Always 200 when the request is valid; each ID gets its own result. not_found means the ID is not in your company — unknown IDs and other customers’ IDs are indistinguishable.

Authentication

X-Company-API-Keystring

Company API key with the calls:read scope, created in the SimZ portal under API Access.

Request

This endpoint expects an object.
call_idslist of stringsRequired

1–100 call IDs; duplicates are removed.

includelist of enumsOptional

Defaults to ["transcript"].

Allowed values:

Response

Per-call results.

successbooleanOptional
request_idstringOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
503
Service Unavailable Error