Calls
- GETGet Calls
- GETGet Call
- GETGet Transcript
- GETGet current page
- GETList Call tags
- GETReturn a pre-signed URL to the call recording
- GETReturn the logs for a call
- GETGet the usage for the given organization
- POSTStop Call
- POSTCancel Call
- POSTAdd a note to a call
- POSTTrigger async export of calls CSV to requester email
- PATCHUpdate a note on a call
- PATCHSet call as viewed by the user making the request
- PATCHSet call rating
- DELDelete a note from a call
- DELDelete a call
Dial
Orgs
Numbers
Usecases
Agents
Get Transcript
Returns the transcript for a call.
curl --request GET \
--url https://app.happyrobot.ai/api/v1/calls/{id}/transcript \
--header 'authorization: <authorization>'{
"id": "<string>",
"organization_id": "<string>",
"call_id": "<string>",
"start_time": 123,
"messages": [
{
"id": "<string>",
"role": "system",
"content": "<string>",
"tool_calls": [
{
"type": "<string>",
"id": "<string>",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"name": "<string>",
"tool_call_id": "<string>",
"start": 123,
"end": 123,
"unpreferred_messages": [
{
"id": "<string>",
"content": "<string>",
"tool_calls": [
{
"type": "<string>",
"id": "<string>",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
]
}
],
"interrupted_thoughts": "<string>",
"is_filler": true,
"discard": false,
"transfer_contact": {
"type": "Sales Rep",
"name": "<string>",
"email": "<string>",
"phone": {
"number": "<string>",
"extension": "<string>"
},
"contact_id": "<string>",
"slack_channel_id": "<string>"
}
}
]
}Headers
Your API key for authentication. Use Bearer format.
"Bearer API_KEY"
Path Parameters
ID of the call.
24Response
Unique identifier for the transcript.
ID of the organization that owns the transcript.
ID of the call that the transcript is associated with.
Start unix time of the transcript.
Messages that make up the transcript.
Unique identifier for the message.
Role of the message.
system, assistant, user, tool Start time in seconds.
Content of the message.
Tool calls made by the assistant.
Type of the tool call.
ID of the tool call.
Name of the tool.
ID of the tool call.
End time in seconds.
Unpreferred messages.
Unique identifier for the unpreferred message.
Content of the unpreferred message.
Tool calls made by the assistant.
Type of the tool call.
ID of the tool call.
Thoughts that the assistant was going to speak when the user interrupted.
Whether the message is a filler acknowledgement.
Whether the message should be discarded when generating a dataset.
Contact information for the transfer.
Type of the contact.
Sales Rep, Terminal Name of the contact.
Email of the contact.
ID of the contact.
ID of the slack channel.
Was this page helpful?
curl --request GET \
--url https://app.happyrobot.ai/api/v1/calls/{id}/transcript \
--header 'authorization: <authorization>'{
"id": "<string>",
"organization_id": "<string>",
"call_id": "<string>",
"start_time": 123,
"messages": [
{
"id": "<string>",
"role": "system",
"content": "<string>",
"tool_calls": [
{
"type": "<string>",
"id": "<string>",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"name": "<string>",
"tool_call_id": "<string>",
"start": 123,
"end": 123,
"unpreferred_messages": [
{
"id": "<string>",
"content": "<string>",
"tool_calls": [
{
"type": "<string>",
"id": "<string>",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
]
}
],
"interrupted_thoughts": "<string>",
"is_filler": true,
"discard": false,
"transfer_contact": {
"type": "Sales Rep",
"name": "<string>",
"email": "<string>",
"phone": {
"number": "<string>",
"extension": "<string>"
},
"contact_id": "<string>",
"slack_channel_id": "<string>"
}
}
]
}