Skip to main content
GET
/
transcripts
/
{projectID}
/
{transcriptID}
Get Transcript Dialog
curl --request GET \
  --url https://api.voiceflow.com/v2/transcripts/{projectID}/{transcriptID} \
  --header 'Authorization: <api-key>'
[
  {
    "turnID": "<string>",
    "format": "launch",
    "type": "<string>",
    "payload": {},
    "startTime": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

All requests made to the Project API must be validated with the project DM API Key.

Path Parameters

​
projectID
string
required

Voiceflow project ID

Example:

"63204daf2c4a550006873772"

​
transcriptID
string
required

Voiceflow transcript ID

Example:

"63204daf2c4a550006873773"

Query Parameters

​
limit
number

the number of turns to return, use offset to fetch more

Required range: 1 <= x <= 1000
Example:

100

​
offset
number

the number of turns to skip before returning

Required range: x >= 1
Example:

1

​
range
enum<string>

filter transcripts dialog by end date

Available options:
Today,
Yesterday,
Last 7 Days,
Last 30 days,
All time
Example:

"All time"

​
startDate
string

filter transcripts dialog by start date

Example:

"2023-01-01"

​
endDate
string

filter transcripts dialog by end date

Example:

"2023-01-01"

Response

200 - application/json

OK

​
turnID
string

the ID for the turn on a given dialog

​
format
enum<string>

the format of the turn. Launch/request for dialog start, trace for other interactions.

Available options:
launch,
request,
trace
​
type
string

the concrete type of this turn, if format is trace this is the trace type, otherwise shows the turn format

​
payload
object

this holds the actual trace payload sent during the turn

​
startTime
string

the time the interaction was generated