List Agent
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The date after which the agent was created.
The date before which the agent was created.
The index of the page to return.
The limit of items to return in the page.
Response
Whether there is a next page.
The current index of the page selected.
The list of agents returned.
The id of the owner of the agent.
The date and time the agent was created.
The id of the agent.
The date and time the agent was last updated.
The uri of the agent.
The hooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.
hang_up phone_call:connection_requested, phone_call:rejected, phone_call:accepted, function_call:triggered, conversation:started, conversation:ended, conversation:duration, speech:started, speech:ended, message:sent, message:generated The initial message that the agent will say. If null, the agent will wait for the user to speak first.
The language model provider.
openai The credential id to use for the provider. If null, we include the provider cost in the conversation.
The maximum number of tokens to generate for an each response from the agent. Default is 300.
The OpenAI language model to use.
gpt-3.5-turbo, gpt-3.5-turbo-0125, gpt-3.5-turbo-1106, gpt-3.5-turbo-16k, gpt-3.5-turbo-0613, gpt-4-turbo, gpt-4-turbo-2024-04-09, gpt-4-turbo-preview, gpt-4-0125-preview, gpt-4-1106-preview, gpt-4-0613, gpt-4, gpt-4o The temperature of the model. Default is 0 for optimized caching performance.
0 < x < 2The list of OpenAI tools.
The function definition to be called.
The description of the OpenAI function call.
This is the name of the function to be called. Must be less than 64 characters (a-z, A-Z, 0-9, including underscores).
The parameters of the OpenAI function call.
This is the type of OpenAI Tool.
function The maximum conversation duration in seconds. If null, the conversation can be of any duration. The default value is 10 min.
The metadata of the agent. This is used to store additional information about the agent.
The prompt of the agent.
The transcriber provider.
deepgram The credential id to use for the provider. If null, we include the provider cost in the conversation.
Specific keywords you want to detect in the transcription. This is useful to correctly understand product or company names.
The selected language for the transcription.
en, fr, es, de, it, nl, pt, ru, ja, cs, da, el, hi, id, ko, no, pl, sv, tr, uk The deepgram model to use.
nova-2, nova-2-general, nova-2-meeting, nova-2-phonecall, nova-2-finance, nova-2-voicemail, nova-2-medical, nova-2-drivethru, nova-2-automotive, nova-2-conversationalai The voice provider.
playht The credential id to use for the provider. If null, we include the provider cost in the conversation.
The playht model to use.
susan, william, phoebe, arthur, ayla, dylan, madelyn, oliver, sophia Control how fast the generated audio should be. A number greater than 0 and less than or equal to 5.0
0 < x < 5A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
1 < x < 30A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used.
0 < x < 2A number between 1 and 2. This number influences how closely the generated speech adheres to the input text.
1 < x < 2The webhooks of the agent. These are used for real-time conversation events such as function_calls, messages and much more.
The method of the webhook.
GET, POST The url of the webhook. Where the requests will be sent.
phone_call:connection_requested, phone_call:rejected, phone_call:accepted, function_call:triggered, conversation:started, conversation:ended, conversation:duration, speech:started, speech:ended, message:sent, message:generated