Skip to main content
PUT
/
transcripts
Create Transcript
curl --request PUT \
  --url https://api.voiceflow.com/v2/transcripts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionID": "<string>",
  "projectID": "<string>",
  "browser": "chrome, safari",
  "device": "desktop, mobile",
  "os": "macos, windows, linux",
  "reportTags": [
    "<string>"
  ],
  "unread": true,
  "annotations": {
    "_id": {
      "utteranceAddedCount": 123,
      "utteranceAddedTo": "<string>"
    }
  },
  "creatorID": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "user": {
    "name": "John Doe",
    "image": "https://creator.voiceflow.com/assets/vf-logo-f0e2d8a2.png"
  }
}
'
{
  "sessionID": "<string>",
  "_id": "<string>",
  "projectID": "<string>",
  "browser": "chrome, safari",
  "device": "desktop, mobile",
  "os": "macos, windows, linux",
  "reportTags": [
    "<string>"
  ],
  "unread": true,
  "annotations": {
    "_id": {
      "utteranceAddedCount": 123,
      "utteranceAddedTo": "<string>"
    }
  },
  "creatorID": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "user": {
    "name": "John Doe",
    "image": "https://creator.voiceflow.com/assets/vf-logo-f0e2d8a2.png"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
sessionID
string
required

The ID of the conversation session to record as a transcript. This should be the same value as the userID property of the Dialog API.

​
projectID
string

the project ID that the transcript belongs to

​
browser
string

the browser that was used when for the interaction

Example:

"chrome, safari"

​
device
string

the device that was used when for the interaction

Example:

"desktop, mobile"

​
os
string

the operating system that was used when for the interaction

Example:

"macos, windows, linux"

​
reportTags
string[]

the tags associated with the transcript

​
unread
boolean

true if the transcrip is unread, false otherwise

​
annotations
object

the transcript ID

​
creatorID
string

the ID of the user who created the transcript

​
createdAt
string

the date time the transcript was created

​
updatedAt
string

the date time the transcript was updated

​
user
object

Response

200 - application/json

the created transcript record

​
sessionID
string
required

The ID of the conversation session to record as a transcript. This should be the same value as the userID property of the Dialog API.

​
_id
string

the transcript ID

​
projectID
string

the project ID that the transcript belongs to

​
browser
string

the browser that was used when for the interaction

Example:

"chrome, safari"

​
device
string

the device that was used when for the interaction

Example:

"desktop, mobile"

​
os
string

the operating system that was used when for the interaction

Example:

"macos, windows, linux"

​
reportTags
string[]

the tags associated with the transcript

​
unread
boolean

true if the transcrip is unread, false otherwise

​
annotations
object

the transcript ID

​
creatorID
string

the ID of the user who created the transcript

​
createdAt
string

the date time the transcript was created

​
updatedAt
string

the date time the transcript was updated

​
user
object