Agents
Create a new agent
- 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
Agents
Create a new agent
POST
/
agents
authorization
string
*
authorization
Required
string
Your API key for authentication. Use Bearer format.
Add Example Value
curl --request POST \
--url https://app.happyrobot.ai/api/v1/agents \
--header 'authorization: <authorization>'
{
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"languages": [
"english"
],
"voice_id": "<string>",
"created_at": "2024-01-01T01:01:01Z"
}
Headers
authorization
string
requiredYour API key for authentication. Use Bearer format.
Response
200 - application/json
id
string
requiredID of the agent.
organization_id
string | null
ID of the organization.
name
string
requiredName of the agent.
languages
enum<string>[]
requiredLanguages that the agent can speak.
Available options:
english
, spanish
voice_id
string
requiredID of the voice.
created_at
string
requiredCreation date of the agent.
Was this page helpful?
curl --request POST \
--url https://app.happyrobot.ai/api/v1/agents \
--header 'authorization: <authorization>'
{
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"languages": [
"english"
],
"voice_id": "<string>",
"created_at": "2024-01-01T01:01:01Z"
}