Get agent details

GET 
/agents/:agentId

Returns detailed information about a specific agent

Request

Path Parameters

agentId uuidrequired

ID of the agent to retrieve

Responses

200

Successful response with agent details

application/json

Schema

Schema

iduuid
characterobject

iduuid

Unique identifier for the character

namestringrequired

Name of the character

modelProviderstring

The model provider to use (e.g., "openai", "anthropic")

biostring

Short biography of the character

lorestring[]

Extended lore and background information

messageExamplesstring[]

Example messages for character training

postExamplesstring[]

Example posts for character training

topicsstring[]

Topics the character is knowledgeable about

adjectivesstring[]

Personality traits of the character

knowledgestring[]

Knowledge base for the character

pluginsstring[]

Plugins used by the character

settingsobject

Character-specific settings

styleobject

Character's communication style

systemstring

System prompt for the character

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "character": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "modelProvider": "string",
    "bio": "string",
    "lore": [
      "string"
    ],
    "messageExamples": [
      "string"
    ],
    "postExamples": [
      "string"
    ],
    "topics": [
      "string"
    ],
    "adjectives": [
      "string"
    ],
    "knowledge": [
      "string"
    ],
    "plugins": [
      "string"
    ],
    "settings": {},
    "style": {},
    "system": "string"
  }
}

404

Agent not found

application/json

Schema

Schema

errorstring
Example: Agent not found

Example (from schema)

{
  "error": "Agent not found"
}