Get Agent

GET

chat

agents

{id}

Get agent

curl --request GET \
  --url https://api.agntix.ai/v2/chat/agents/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.agntix.ai/v2/chat/agents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Customer Support Bot",
  "description": "Handles tier-1 customer queries",
  "role": "You are a helpful support agent for Acme Inc.",
  "language": "en",
  "systemPrompt": "<string>",
  "voiceEnabled": false,
  "voicePipelineMode": "<string>",
  "isActive": true,
  "isPublic": false,
  "orgId": "org_2abc123",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2026-04-28T11:42:11Z",
  "updatedAt": "2026-04-28T11:42:11Z",
  "model": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "provider": "<string>"
  },
  "agentTools": [
    {
      "tool": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "GET_ACCOUNT_BALANCE",
        "description": "<string>",
        "ajvPropertiesSchema": {},
        "orgId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "agentKnowledgeStore": {
    "id": "<string>",
    "name": "<string>"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "status": 401
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent not found.",
    "status": 404
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

Every endpoint on this page requires either a Clerk-issued JWT (Authorization: Bearer <token>) or an organization API key (x-api-key: pk_…). Anonymous calls return 401 Unauthorized. See Authentication for the full setup.

Code examples

curl https://api.agntix.ai/v2/chat/agents/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "x-api-key: pk_live_••••"

const agentId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

const res = await fetch(`https://api.agntix.ai/v2/chat/agents/${agentId}`, {
  headers: { 'x-api-key': 'pk_live_••••' },
});
const agent = await res.json();
console.log('Tools attached:', agent.agentTools?.length ?? 0);

import httpx

agent_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

agent = httpx.get(
    f"https://api.agntix.ai/v2/chat/agents/{agent_id}",
    headers={"x-api-key": "pk_live_••••"},
).json()
print("Model:", agent["model"]["name"])

Sample response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Customer Support Bot",
  "description": "Handles tier-1 customer queries",
  "role": "You are a helpful, concise support agent for Acme Inc.",
  "language": "en",
  "systemPrompt": "You specialize in billing, returns, and account access.",
  "voiceEnabled": false,
  "isActive": true,
  "isPublic": false,
  "orgId": "org_2abc123",
  "model": {
    "id": "96f3b0a3-1234-5678-abcd-ef1234567890",
    "name": "gpt-4.1",
    "provider": "openai"
  },
  "agentTools": [
    {
      "tool": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "GET_ACCOUNT_BALANCE",
        "description": "Retrieves the current account balance."
      }
    }
  ],
  "agentKnowledgeStore": null,
  "createdAt": "2026-04-29T08:00:00Z",
  "updatedAt": "2026-04-29T08:00:00Z"
}

Authorizations

x-api-key

string

header

required

Organization API key. Obtain from the dashboard. Format: pk_live_…

Path Parameters

string<uuid>

required

Agent UUID.

Response

Agent detail.

string<uuid>

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

fullName

string

Example:

"Customer Support Bot"

description

string

Example:

"Handles tier-1 customer queries"

role

string

Example:

"You are a helpful support agent for Acme Inc."

language

string

Example:

"en"

systemPrompt

string

voiceEnabled

boolean

Example:

false

voicePipelineMode

string | null

isActive

boolean

Example:

true

isPublic

boolean

Example:

false

orgId

string

Example:

"org_2abc123"

modelId

string<uuid>

createdAt

string<date-time>

Example:

"2026-04-28T11:42:11Z"

updatedAt

string<date-time>

Example:

"2026-04-28T11:42:11Z"

model

object

Show child attributes

agentTools

object[]

Show child attributes

agentKnowledgeStore

object | null

Show child attributes

Get agent

curl --request GET \
  --url https://api.agntix.ai/v2/chat/agents/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.agntix.ai/v2/chat/agents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Customer Support Bot",
  "description": "Handles tier-1 customer queries",
  "role": "You are a helpful support agent for Acme Inc.",
  "language": "en",
  "systemPrompt": "<string>",
  "voiceEnabled": false,
  "voicePipelineMode": "<string>",
  "isActive": true,
  "isPublic": false,
  "orgId": "org_2abc123",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2026-04-28T11:42:11Z",
  "updatedAt": "2026-04-28T11:42:11Z",
  "model": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "provider": "<string>"
  },
  "agentTools": [
    {
      "tool": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "GET_ACCOUNT_BALANCE",
        "description": "<string>",
        "ajvPropertiesSchema": {},
        "orgId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "agentKnowledgeStore": {
    "id": "<string>",
    "name": "<string>"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "status": 401
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent not found.",
    "status": 404
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

Overview

Agents

Chat

Voice

Tools

Phone Numbers

Code examples

Sample response

Authorizations

Path Parameters

Response

​Code examples

​Sample response

Authorizations

Path Parameters

Response

Code examples

Sample response