Create a new voice agent. Required body: name, isActive, templateId. Use when a user wants to add a new agent.
- Endpoint
- POST /agents
- Auth
- x-api-key/session; agent:create
- Source
- apps/server/src/modules/agent/agent.route.ts
Creates data.
tool
create_agent_preview_session
WriteCreate a temporary LiveKit preview session for an agent. Required param: agentId. Optional body.dynamicVariables.
- Endpoint
- POST /agents/:agentId/preview-session
- Auth
- x-api-key/session; agentConfiguration:read
- Source
- apps/server/src/modules/agent/agent.route.ts
Triggers temporary runtime session.
Update agent metadata such as name, active state, or template id.
- Endpoint
- PATCH /agents/:id
- Auth
- x-api-key/session; agent:update
- Source
- apps/server/src/modules/agent/agent.route.ts
Mutates agent.
Delete an agent by id. Use only after confirmation.
- Endpoint
- DELETE /agents/:agentId
- Auth
- x-api-key/session; agent:delete
- Source
- apps/server/src/modules/agent/agent.route.ts
Deletes data.
Create or update a voice agent configuration including first message, system prompt, models, voice, webhooks, variables, RAG, IVR, and timezone.
- Endpoint
- POST /agents/:agentId/config
- Auth
- x-api-key/session; agentConfiguration:create/update
- Source
- apps/server/src/modules/agent/agent.route.ts
Mutates configuration.
End a currently live call by LiveKit room name. Use only when the user explicitly wants to terminate a live call.
- Endpoint
- POST /calls/live/end
- Auth
- x-api-key/session; callLogs:delete
- Source
- apps/server/src/modules/calllogs/calllog.route.ts
Triggers call termination.
Soft-delete a call log by id. Use only after confirmation.
- Endpoint
- DELETE /calls/:callId
- Auth
- x-api-key/session; callLogs:delete
- Source
- apps/server/src/modules/calllogs/calllog.route.ts
Deletes data.
tool
create_knowledge_sources
WriteCreate knowledge sources for an agent from URLs or uploaded files.
- Endpoint
- POST /kb
- Auth
- x-api-key/session; knowledgeSource:create
- Source
- apps/server/src/modules/kb/kb.route.ts
Creates records and triggers ingestion.
Generate a presigned S3 upload URL for a knowledge base file before creating a source.
- Endpoint
- GET /kb/upload-url
- Auth
- x-api-key/session; knowledgeSource:create
- Source
- apps/server/src/modules/kb/kb.route.ts
Generates a short-lived upload credential.
tool
update_knowledge_source
WriteUpdate supported knowledge source fields and queue reprocessing.
- Endpoint
- PATCH /kb/:kbId
- Auth
- x-api-key/session; knowledgeSource:update
- Source
- apps/server/src/modules/kb/kb.route.ts
Mutates source configuration and refreshes indexed content.
tool
delete_knowledge_source
DestructiveDelete one knowledge source by id.
- Endpoint
- DELETE /kb/:kbId
- Auth
- x-api-key/session; knowledgeSource:delete
- Source
- apps/server/src/modules/kb/kb.route.ts
Deletes data.
tool
create_quick_outbound_call
Cost actionDispatch a single outbound call for an agent to a phone number.
- Endpoint
- POST /outbound-calls/quick
- Auth
- x-api-key/session; outboundCalls:create
- Source
- apps/server/src/modules/outbound/outbound-call.route.ts
Triggers outbound call.
tool
create_batch_upload_url
Cost actionGenerate presigned upload URL for outbound batch CSV/XLSX file.
- Endpoint
- GET /outbound-calls/batch-upload-url
- Auth
- x-api-key/session; outboundCalls:create
- Source
- apps/server/src/modules/outbound/outbound-call.route.ts
Generates short-lived upload credential.
tool
create_batch_campaign
Cost actionCreate an outbound batch campaign from an uploaded CSV/XLSX source file.
- Endpoint
- POST /outbound-calls/batches
- Auth
- x-api-key/session; outboundCalls:create
- Source
- apps/server/src/modules/outbound/outbound-call.route.ts
Creates campaign.
tool
cancel_batch_campaign
Cost actionCancel an outbound batch campaign.
- Endpoint
- POST /outbound-calls/batches/:campaignId/cancel
- Auth
- x-api-key/session; outboundCalls:delete
- Source
- apps/server/src/modules/outbound/outbound-call.route.ts
Mutates/cancels campaign.
Cancel a scheduled/running outbound call.
- Endpoint
- POST /outbound-calls/:outboundId/cancel
- Auth
- x-api-key/session; outboundCalls:delete
- Source
- apps/server/src/modules/outbound/outbound-call.route.ts
Mutates/cancels call.
Retry a failed outbound call.
- Endpoint
- POST /outbound-calls/:outboundId/retry
- Auth
- x-api-key/session; outboundCalls:create
- Source
- apps/server/src/modules/outbound/outbound-call.route.ts
Triggers new call attempt.
Create an API tool an agent can call during conversations.
- Endpoint
- POST /tools
- Auth
- x-api-key/session; tools:create
- Source
- apps/server/src/modules/tools/tool.route.ts
Creates tool.
Update an existing API tool configuration.
- Endpoint
- PATCH /tools/:toolId
- Auth
- x-api-key/session; tools:update
- Source
- apps/server/src/modules/tools/tool.route.ts
Mutates tool.
Delete an API tool.
- Endpoint
- DELETE /tools/:toolId
- Auth
- x-api-key/session; tools:delete
- Source
- apps/server/src/modules/tools/tool.route.ts
Deletes tool.
Attach an organization API tool to an agent.
- Endpoint
- POST /tools/:toolId/attach/:agentId
- Auth
- x-api-key/session; tools:update
- Source
- apps/server/src/modules/tools/tool.route.ts
Mutates agent-tool relationship.
tool
detach_tool_from_agent
ReadDetach an organization API tool from an agent.
- Endpoint
- DELETE /tools/:toolId/detach/:agentId
- Auth
- x-api-key/session; tools:update
- Source
- apps/server/src/modules/tools/tool.route.ts
Mutates agent-tool relationship.
Create a secret value for webhook/tool configuration.
- Endpoint
- POST /secrets
- Auth
- x-api-key/session; secrets:create
- Source
- apps/server/src/modules/secrets/secret.route.ts
Creates secret.
Delete a stored secret by id.
- Endpoint
- DELETE /secrets/:secretId
- Auth
- x-api-key/session; secrets:delete
- Source
- apps/server/src/modules/secrets/secret.route.ts
Deletes secret.
Create a public website voice widget for an agent.
- Endpoint
- POST /agents/:agentId/widgets
- Auth
- x-api-key/session; agentWidget:create
- Source
- apps/server/src/modules/widgets/widget.route.ts
Creates widget.
Update a website widget configuration including theme, origin allowlist, consent, and enabled state.
- Endpoint
- PATCH /widgets/:widgetId
- Auth
- x-api-key/session; agentWidget:update
- Source
- apps/server/src/modules/widgets/widget.route.ts
Mutates widget.
Delete a website widget.
- Endpoint
- DELETE /widgets/:widgetId
- Auth
- x-api-key/session; agentWidget:delete
- Source
- apps/server/src/modules/widgets/widget.route.ts
Deletes widget.
Connect a new remote MCP server from catalog or custom URL.
- Endpoint
- POST /mcp/connections
- Auth
- x-api-key/session; tools:create
- Source
- apps/server/src/modules/mcp/mcp.route.ts
Creates connection.
tool
refresh_mcp_connection
ReadRefresh tool metadata/status for a connected MCP server.
- Endpoint
- POST /mcp/connections/:mcpConnectionId/refresh
- Auth
- x-api-key/session; tools:update
- Source
- apps/server/src/modules/mcp/mcp.route.ts
Triggers refresh.
tool
disconnect_mcp_connection
WriteDisconnect a remote MCP server.
- Endpoint
- DELETE /mcp/connections/:mcpConnectionId
- Auth
- x-api-key/session; tools:delete
- Source
- apps/server/src/modules/mcp/mcp.route.ts
Deletes connection.
tool
attach_mcp_connection_to_agent
WriteAttach a connected MCP server to an agent.
- Endpoint
- POST /mcp/connections/:mcpConnectionId/attach/:agentId
- Auth
- x-api-key/session; tools:update
- Source
- apps/server/src/modules/mcp/mcp.route.ts
Mutates relationship.
tool
detach_mcp_connection_from_agent
ReadDetach a connected MCP server from an agent.
- Endpoint
- DELETE /mcp/connections/:mcpConnectionId/detach/:agentId
- Auth
- x-api-key/session; tools:update
- Source
- apps/server/src/modules/mcp/mcp.route.ts
Mutates relationship.
tool
execute_connected_mcp_tool
ReadExecute a tool on a connected remote MCP server through QuickVoice.
- Endpoint
- POST /mcp/connections/:mcpConnectionId/tools/:toolName/execute
- Auth
- x-api-key/session; tools:read
- Source
- apps/server/src/modules/mcp/mcp.route.ts
Executes remote action.