Calls
Get Transcript
- Dashboard
- Community
- GETReturn the logs for a call
- PATCHSet call as viewed by the user making the request
- GETGets an organization's usage
- GETList Call tags
- PATCHUpdate a note on a call
- GETGet Call
- POSTAdd a note to a call
- GETList Calls
- GETGet Transcript
- PATCHSet call rating
- GETGet Calls
- POSTStop Call
- DELDelete a call
- GETReturn a pre-signed URL to the call recording
- DELDelete a note from a call
- POSTCreate Assistant
- PATCHUpdate Assistant
- DELDelete Assistant
- GETList Assistants
- GETGet Assistant
- PATCHUpdate an existing tool
- GETReturns a list of tools for a use case id
- DELDelete a tool
- POSTCreate a new tool
- GETReturns a list of tools for a use case id
- GETReturns a list of tools for a use case id
- GETGet Campaigns
- POSTCreate batched Outbound Calls
- POSTCreate Outbound Call
- POSTCreate Outbound Call
- GETGet all users for an organization
- POSTCreate a new member for an organization
- GETGet an organization
- DELDelete a member from an organization
- PATCHUpdate a user
- PATCHUpdate an organization
- DELDelete a list of numbers
- GETReturns a list of phone numbers
- DELDelete a phone number
- PATCHUpdate a phone number routes
- POSTBuy a new phone number
- GETReturns a single number
- POSTCreate a new hook
- PATCHUpdate an existing hook
- GETReturns a list of hooks for an assistant id
- DELDelete a hook
- DELDelete a message
- GETReturns a list of samples for an assistant id
- POSTGenerate a list of samples in jsonl format
- GETReturns a sample by id
- POSTAdd a new message
- DELDelete a list of samples
- PATCHUpdate an existing example
- PATCHUpdate an existing message
- POSTCreate a new sample
- POSTDownload a backup of a list of samples
- GETGet Use Case
- POSTCreate a Use Case
- DELDelete Use Case
- GETList Use Cases
- PATCHUpdate Use Case
- POSTCreate a label for Use Case
- DELDelete Use Case's label
- POSTCreate a new agent
- GETReturns a list of agents
- DELDelete an agent
- GETReturns a single agent
- PATCHUpdate an existing agent
- GETReturn the logs for a call
- PATCHSet call as viewed by the user making the request
- GETGets an organization's usage
- GETList Call tags
- PATCHUpdate a note on a call
- GETGet Call
- POSTAdd a note to a call
- POSTCancel Call
- GETGet Transcript
- PATCHSet call rating
- GETList Calls
- POSTStop Call
- DELDelete a call
- GETReturn a pre-signed URL to the call recording
- DELDelete a note from a call
Calls
Assistants
Tools
Dial
Orgs
Numbers
Hooks
Samples
Usecases
Agents
Analytics
Calls
Get Transcript
Returns the transcript for a call.
GET
/
calls
/
{id}
/
transcript
authorization
string
*
authorization
Required
string
Your API key for authentication. Use Bearer format.
Add Example Value
id
string
*
id
Required
string
ID of the 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": true
}
]
}Headers
authorization
string
requiredYour API key for authentication. Use Bearer format.
Path Parameters
id
string
requiredID of the call.
Response
200 - application/json
id
string
requiredUnique identifier for the transcript.
organization_id
string
requiredID of the organization that owns the transcript.
call_id
string
requiredID of the call that the transcript is associated with.
start_time
number
requiredStart unix time of the transcript.
messages
object[]
requiredMessages that make up the transcript.
messages.id
string
requiredUnique identifier for the message.
messages.role
enum<string>
requiredRole of the message.
Available options:
system, assistant, user, tool messages.content
string
Content of the message.
messages.tool_calls
object[]
Tool calls made by the assistant.
messages.tool_calls.type
string
requiredType of the tool call.
messages.tool_calls.id
string
requiredID of the tool call.
messages.tool_calls.function
object
requiredFunction to call.
messages.tool_calls.function.name
string
requiredName of the function to call.
messages.tool_calls.function.arguments
string
requiredArguments to pass to the function.
messages.name
string
Name of the tool.
messages.tool_call_id
string
ID of the tool call.
messages.start
number
requiredStart time in seconds.
messages.end
number
End time in seconds.
messages.unpreferred_messages
object[]
Unpreferred messages.
messages.unpreferred_messages.id
string
requiredUnique identifier for the unpreferred message.
messages.unpreferred_messages.content
string
Content of the unpreferred message.
messages.unpreferred_messages.tool_calls
object[]
Tool calls made by the assistant.
messages.unpreferred_messages.tool_calls.type
string
requiredType of the tool call.
messages.unpreferred_messages.tool_calls.id
string
requiredID of the tool call.
messages.unpreferred_messages.tool_calls.function
object
requiredFunction to call.
messages.unpreferred_messages.tool_calls.function.name
string
requiredName of the function to call.
messages.unpreferred_messages.tool_calls.function.arguments
string
requiredArguments to pass to the function.
messages.interrupted_thoughts
string | null
Thoughts that the assistant was going to speak when the user interrupted.
messages.is_filler
boolean
Whether the message is a filler acknowledgement.
messages.discard
boolean
default: falseWhether the message should be discarded when generating a dataset.
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": true
}
]
}