Skip to main content
GET
/
v1
/
transcript
/
{transcriptID}
Get transcript
curl --request GET \
  --url https://analytics-api.voiceflow.com/v1/transcript/{transcriptID} \
  --header 'authorization: <api-key>'
{
  "transcript": {
    "id": "<string>",
    "userID": "<string>",
    "sessionID": "<string>",
    "projectID": "<string>",
    "environmentID": "<string>",
    "createdAt": "2023-12-25",
    "updatedAt": "2023-12-25",
    "expiresAt": "2023-12-25",
    "endedAt": "2023-12-25",
    "recordingURL": "<string>",
    "properties": [
      {
        "value": "<string>",
        "metadata": {},
        "createdAt": "2023-12-25",
        "updatedAt": "2023-12-25",
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "default": true
      }
    ],
    "evaluations": [
      {
        "value": 123,
        "reason": "<string>",
        "cost": 123,
        "createdAt": "2023-12-25",
        "updatedAt": "2023-12-25",
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "default": true
      }
    ],
    "history": [
      {
        "id": "<string>",
        "createdAt": "2023-12-25"
      }
    ],
    "logs": [
      {
        "data": "<string>",
        "createdAt": "2023-12-25",
        "updatedAt": "2023-12-25"
      }
    ]
  }
}

Authorizations

​
authorization
string
header
required

Voiceflow API key

Path Parameters

​
transcriptID
string
required

ID of the transcript to target.

Query Parameters

​
unredacted
boolean

When enabled, un-redacted logs will be returned if they are still available.

​
filterConversation
boolean

When enabled, only text, speak and live-agent-handoff traces will be returned.

​
customTraceTypes
string[]

Used to indicate additional trace types that should be returned when filterConversation is enabled.

​
encode
boolean

Escape HTML special characters that appear in transcripts.

Response

200 - application/json
​
transcript
object
required