Skip to main content
GET
/
agent
/
{id}
Get an agent
curl --request GET \
  --url https://api.vocobase.com/api/v2/agent/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "prompt": "<string>",
    "voice_id": "<string>",
    "language": "<string>",
    "agent_type": "inbound",
    "intro_message": "<string>",
    "enable_recording": true,
    "kb_threshold": "low",
    "kb_include_summaries": true,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": true,
    "kb_llm_system_prompt": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "document_count": 123,
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

​
id
string<uuid>
required

Agent ID.

Response

Agent details.

​
success
boolean
​
data
object