- 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
Samples
Add a new message
POST
/
samples
/
{id}
/
messages
authorization
string
*
authorization
Required
string
id
string
*
id
Required
string
object
index
number
index
number
message
object
*
message
Required
object
id
string
*
id
Required
string
Unique identifier for the message.
role
enum<string>
*
role
Required
enum<string>
Role of the message.
content
string
content
string
Content of the message.
tool_calls
array
tool_calls
array
Tool calls made by the assistant.
name
string
name
string
Name of the tool.
tool_call_id
string
tool_call_id
string
ID of the tool call.
start
number
*
start
Required
number
Start unix time of the message.
end
number
end
number
End unix time of the message.
interrupted_thoughts
string
interrupted_thoughts
string
Thoughts that the assistant was going to speak when the user interrupted.
discard
boolean
discard
boolean
Whether the message should be discarded when generating a dataset.
curl --request POST \
--url https://app.happyrobot.ai/api/v1/samples/{id}/messages \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '{
"index": 123,
"message": {
"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,
"interrupted_thoughts": "<string>",
"discard": true
}
}'{
"messageId": "<string>",
"sample": {
"id": "<string>",
"organization_id": "<string>",
"assistant_id": "<string>",
"call_id": "<string>",
"split": "train",
"created": "<string>",
"status": "to_review",
"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,
"interrupted_thoughts": "<string>",
"discard": true
}
]
}
}Headers
authorization
string
requiredPath Parameters
id
string
requiredBody
application/json
index
number
message
object
requiredmessage.id
string
requiredUnique identifier for the message.
message.role
enum<string>
requiredRole of the message.
Available options:
system, assistant, user, tool message.content
string
Content of the message.
message.tool_calls
object[]
Tool calls made by the assistant.
message.tool_calls.type
string
requiredType of the tool call.
message.tool_calls.id
string
requiredID of the tool call.
message.tool_calls.function
object
requiredFunction to call.
message.tool_calls.function.name
string
requiredName of the function to call.
message.tool_calls.function.arguments
string
requiredArguments to pass to the function.
message.name
string
Name of the tool.
message.tool_call_id
string
ID of the tool call.
message.start
number
requiredStart unix time of the message.
message.end
number
End unix time of the message.
message.interrupted_thoughts
string | null
Thoughts that the assistant was going to speak when the user interrupted.
message.discard
boolean
default: falseWhether the message should be discarded when generating a dataset.
Response
200 - application/json
messageId
string
requiredsample
object
requiredsample.id
string
requiredsample.organization_id
string
requiredsample.assistant_id
string
requiredsample.call_id
string
sample.split
enum<string>
requiredAvailable options:
train, test sample.created
string
requiredsample.status
enum<string>
requiredAvailable options:
to_review, reviewed, final sample.messages
object[]
requiredsample.messages.id
string
requiredUnique identifier for the message.
sample.messages.role
enum<string>
requiredRole of the message.
Available options:
system, assistant, user, tool sample.messages.content
string
Content of the message.
sample.messages.tool_calls
object[]
Tool calls made by the assistant.
sample.messages.tool_calls.type
string
requiredType of the tool call.
sample.messages.tool_calls.id
string
requiredID of the tool call.
sample.messages.tool_calls.function
object
requiredFunction to call.
sample.messages.tool_calls.function.name
string
requiredName of the function to call.
sample.messages.tool_calls.function.arguments
string
requiredArguments to pass to the function.
sample.messages.name
string
Name of the tool.
sample.messages.tool_call_id
string
ID of the tool call.
sample.messages.start
number
requiredStart unix time of the message.
sample.messages.end
number
End unix time of the message.
sample.messages.interrupted_thoughts
string | null
Thoughts that the assistant was going to speak when the user interrupted.
sample.messages.discard
boolean
default: falseWhether the message should be discarded when generating a dataset.
Was this page helpful?
curl --request POST \
--url https://app.happyrobot.ai/api/v1/samples/{id}/messages \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '{
"index": 123,
"message": {
"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,
"interrupted_thoughts": "<string>",
"discard": true
}
}'{
"messageId": "<string>",
"sample": {
"id": "<string>",
"organization_id": "<string>",
"assistant_id": "<string>",
"call_id": "<string>",
"split": "train",
"created": "<string>",
"status": "to_review",
"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,
"interrupted_thoughts": "<string>",
"discard": true
}
]
}
}