AI Agent API resource for managing AI Agents.
GET /api/v1/voice_agents
List all AI Agents available to the authenticated company.
Params
| Param name | Description Validations |
|---|---|
| ids Optional |
Return records matching these ids. Validations: - Must be an array of decimal values. EG: [0, 1, 2, 3] |
| page Optional |
Return the next page of results. Validations: - Must be a number. |
| per_page Optional |
How many results to return per page. The default is 25. Validations: - Must be a number. |
| created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations: - Must be a String |
| created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations: - Must be a String |
| fulltext Optional |
Search for any record that matches this text Validations: - Must be a String |
| time_zone Optional |
Date ranges will be parsed using this time zone. Validations: - Must be a valid time zone. See the list of valid time zones. |
| columns Optional |
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. Validations: - Must be a String |
| root Optional |
Pass root=false to return results without a root node and metadata. Validations: - Must be a boolean value: 1, true, yes, on, 0, false, no, off |
GET /api/v1/voice_agents/new
Return a new AI Agent object pre-populated with default values (not persisted).
Params
| Param name | Description Validations |
|---|---|
| name OptionalBlank Value Allowed |
Name – Internal name for the AI Agent. Used for identification within the platform. Validations: - Must be a String |
| description OptionalBlank Value Allowed |
Description – Short summary describing the purpose and behavior of the AI Agent. Validations: - Must be a String |
| system_prompt OptionalBlank Value Allowed |
System Prompt – Global instruction set applied to all flows in this AI Agent. Defines tone, rules, and constraints. Validations: - Must be a String |
| conversation_timeout OptionalBlank Value Allowed |
Conversation Timeout Default – Default per-prompt timeout (in seconds) before the conversation ends if no response is received. Resets after each prompt unless overridden by a flow. Validations: - Must be a decimal number. |
POST /api/v1/voice_agents
Create a new AI Agent with the provided attributes.
Params
GET /api/v1/voice_agents/:id
Retrieve a single AI Agent by its unique ID.
PUT /api/v1/voice_agents/:id
Update an existing AI Agent by its unique ID.
Params
DELETE /api/v1/voice_agents/:id
Delete an AI Agent by its unique ID. This will soft-delete the record unless permanently removed.