Skip to content

Get AI Agent Details

Request

Security
HTTP_BASIC
Path
agent_idstring^[A-Za-z0-9_-]+$required

Agent ID containing letters, digits, hyphens, or underscores only.

Example:155
curl -i -X GET \
  -u '<username>:<password>' \
  https://tapi.avanser.com/v1/aiagents/155

Responses

Successful response

Bodyapplication/json
@transactionobject
responseobject(AIAgentDetail)

Configured AI Agent details.

Response
{
  "@transaction": {
    "id": "c9220015e2f48bc7cf4b38186a7b2025",
    "account-id": "1234",
    "request": { … }
  },
  "response": {
    "id": 120,
    "agent_name": "Education Assistant",
    "agent_role": "info",
    "custom_agent_role": null,
    "business_type": "education",
    "custom_business_type": null,
    "business_name": "Example Education",
    "business_description": "Answers course questions and helps book consultations.",
    "contact_email": "info@example.tld",
    "greeting": "friendly",
    "voice": "alloy",
    "instructions": "Answer questions about education services and help callers book a consultation.",
    "created_at": "2026-01-30T05:34:00.000Z",
    "@links": { … }
  }
}