Start a new agent

POST 
/agent/start

Starts a new agent using either a character path or JSON configuration

Request

application/json

Body

required

oneOf

MOD1

characterPathstringrequired

Path to a character file

MOD2

characterJsonobjectrequired

Character configuration in JSON format

Responses

200

Agent started successfully

application/json

Schema

Schema

iduuid

ID of the started agent

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"
  }
}

400

Invalid input (character parsing error)

application/json

Schema

Schema

errorstring

Example (from schema)

{
  "error": "string"
}