Agents
Update agent
Update an existing agent. Send only the fields you want to change.
PUT/agents/
Bearersession
Path parameters
agent_idrequiredBody
18 fields
·
Name for the agent.
Initial message the agent will say when answering a call.
curl -X PUT 'https://backend.omnidim.io/api/v1/agents/{agent_id}' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "name": "Customer Support Agent", "welcome_message": "Hello! How can I help you today?", "dynamic_variables": { "customer_name": "Jane Doe", "order_id": "ORD-12345" }, "context_breakdown": [ { "title": "Purpose", "body": "This agent helps customers with product inquiries and support issues.", "is_enabled": true } ], "transcriber": { "provider": "deepgram_stream", "model": "nova-3", "language": "en-US", "silence_timeout_ms": 400, "interruption_min_words": 2, "max_call_duration_in_sec": 600 }, "model": { "model": "gpt-4.1-mini", "temperature": 0.7 }, "voice": { "provider": "eleven_labs", "voice_id": "JBFqnCBsd6RMkjVDRZzb", "model": "sonic-3.5", "speech_speed": 1 }, "web_search": { "provider": "DuckDuckGo" }, "post_call_actions": { "email": { "recipients": [ "support@example.com" ], "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ], "trigger_call_statuses": [ "completed", "voicemail_detected" ] }, "webhook": { "url": "https://your-webhook-endpoint.com/omnidim-callback", "extracted_variables": [ { "key": "customer_issue", "prompt": "Identify the main issue the customer is experiencing." } ], "trigger_call_statuses": [ "completed", "failed" ] } }, "transfer": { "transfer_options": [ { "number": "+15551234567", "type": "static", "transfer_condition": "Transfer if the customer asks to speak with a human.", "transfer_message": "Please hold while I connect you to one of our agents." } ] }, "end_call": { "condition": "End the call once the customer'\''s issue is resolved.", "message": "Thank you for contacting us. Have a great day!", "message_prompt": "End the call politely in the same language the user is speaking." }, "background_track": { "volume": 0.2 }, "languages": [ "English (India)", "Hindi" ] }'
Example response
{ "id": 6365, "name": "Updated Support Agent", "status": "Completed" }
Authorization
BearerAuth AuthorizationBearer <token>
Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Path Parameters
agent_id*integer
The ID of the agent.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json