Skip to main content
GET
/
api
/
agents
/
{id}
Get agent by ID
curl --request GET \
  --url http://localhost:3000/api/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "Customer Support Agent",
  "instructions": "<string>",
  "status": "draft",
  "version": 123,
  "modelConfig": {
    "model": "openai/gpt-4o",
    "modelSettings": {},
    "providerOptions": {}
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "policy": "<string>",
  "metadata": {},
  "knowledgeBaseConfig": {},
  "createdBy": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Agent ID

Response

Agent details

id
string
required

Agent ID

organizationId
string
required

Organization ID

name
string
required

Agent name

Example:

"Customer Support Agent"

instructions
string
required

Agent instructions

status
enum<string>
required

Agent status

Available options:
draft,
active,
archived
version
number
required

Agent version

modelConfig
object
required

Model configuration

createdAt
string<date-time>
required

Created at timestamp

updatedAt
string<date-time>
required

Updated at timestamp

description
string | null

Agent description

policy
string | null

Agent policy (business rules)

voiceConfig
object

Voice configuration

memoryConfig
object

Memory configuration

metadata
object

Additional metadata

knowledgeBaseConfig
object

Knowledge base configuration for RAG

createdBy
string | null

Created by user ID