Skip to navigation

Get transcripts

View as Markdown

Returns the turn-by-turn transcript of one interaction. An unknown interaction_id returns 200 with an empty messages array.

Roles here are assistant and user. Inline transcripts from List interactions use agent and user.

Path parameters

org_idstringRequired
Organization ID.
workspace_idstringRequired
Workspace ID.
app_idstringRequired

Agent ID. Copy it from the agent’s ··· menu in the dashboard (Copy agent ID).

interaction_idstringRequiredformat: "^[0-9]{8}/.+$"

From List interactions, in the form <YYYYMMDD>/<id>, e.g. 20261007/9f1c2a7e-4b3d-4e8a-a1f0-6c2d9b7e5a14. Send the slash as is or as %2F.

Headers

X-API-KeystringRequired
Your workspace API key.

Response

The interaction’s transcript. messages is empty when the interaction is unknown.

interaction_idstring
The interaction's ID, as requested.
messageslist of objects
The conversation's messages. Empty when the interaction is unknown or has no transcript.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error