Get transcript

Returns one recorded conversation, including the turns exchanged and the traces behind them. Set filterConversation to keep only text, speak, and live-agent-handoff traces, plus any types listed in customTraceTypes.

GET /v1/stable/transcript/{transcriptID}

Get transcript

cURL

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/transcript/{transcriptID} \
  --header 'Authorization: Bearer <token>'

200

{
  "transcript": {
    "id": "<string>",
    "userID": "<string>",
    "endedAt": "2023-11-07T05:31:56Z",
    "projectID": "<string>",
    "sessionID": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "properties": [
      {
        "id": "<string>",
        "name": "<string>",
        "default": true,
        "type": "boolean",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "value": "<string>"
      }
    ],
    "evaluations": [
      {
        "id": "<string>",
        "name": "<string>",
        "default": true,
        "description": "<string>",
        "cost": 123,
        "value": true,
        "reason": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "type": "boolean"
      }
    ],
    "recordingURL": "<string>",
    "logs": [
      {
        "type": "trace",
        "data": "<string>",
        "createdAt": "2023-12-25",
        "updatedAt": "2023-12-25"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Voiceflow bearer token

Path Parameters

transcriptID · string · required

The ID of the transcript to operate on.

Query Parameters

projectID · string · required

The ID of the project to operate on.

filterConversation · boolean

When true, only text, speak, and live-agent-handoff traces are returned. Omit it or set false to return the full log. When enabled, only text, speak and live-agent-handoff traces will be returned.

customTraceTypes · string string[]

Extra trace types to keep when filterConversation is true. Ignored when the filter is off. Accepts one type or an array. Additional trace types to return when filterConversation is enabled.

Response

200 - application/json

Returns a single transcript along with its logs, which the search operation leaves out, plus its properties, evaluation results, and recording URL.

transcript · object · required

Show child attributes