API ReferenceAgents
Create agent
Create an agent linked to a workflow. Public workflows are cloned for the team when needed.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Team API key (prefix sk_). You may also send the key via X-Api-Key header.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/console/agents" \ -H "Content-Type: application/json" \ -d '{ "workflow_id": "string", "name": "string", "description": "string" }'{ "message": "Success", "data": { "id": "string", "name": "string", "description": "string", "workflow_id": "string", "language": "en", "persona": "professional", "timezone": "UTC", "logo": "http://example.com", "business_name": "string", "business_address": "string", "business_email": "string", "business_description": "string", "test_channel_code": "string", "status": "development", "status_reason": "string", "escalation_email": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "workflow": { "system_prompt": "string", "rules": [ { "id": "string", "name": "string", "trigger": "string", "condition": "string", "response": "string", "action": "string", "enabled": true } ], "flows": [ { "name": "string", "description": "string", "category": "support", "priority": 5, "is_active": true, "trigger_keywords": [ { "keyword": "string", "weight": "high" } ], "conversation_steps": [ { "type": "text_response", "content": "string", "action": "string", "followup": "string" } ] } ], "tags": [ "string" ], "integrations": [ "string" ], "channels": [ "string" ], "actions": [ "string" ], "guide": { "youtubeUrl": "string", "steps": [ "Step 1: Configure your store", "Step 2: Add products" ] }, "faq": [ { "question": "string", "answer": "string" } ], "setup_steps": [ "string" ], "setup_time": 0, "video_url": "string", "id": "string", "name": "string", "description": "string", "category": "string", "visibility": "private", "is_owner": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } }}