API ReferenceAgents

Get agent

Get one agent with nested knowledge_bases, integrations, and channels summaries.

GET
/api/v1/console/agents/{agentId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string

Response Body

application/json

curl -X GET "https://example.com/api/v1/console/agents/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",    "knowledge_bases": [      {        "id": "string",        "type": "text",        "name": "string",        "description": "string"      }    ],    "integrations": [      {        "id": "string",        "type": "string",        "name": "string",        "status": "string",        "is_connected": true      }    ],    "channels": [      {        "id": "string",        "type": "string",        "name": "string",        "status": "string",        "is_connected": true      }    ]  }}