Update or create an agent

POST 
/agents/:agentId/set

Updates an existing agent or creates a new one with the specified configuration

Request

Path Parameters

agentId uuidrequired

ID of the agent to update

application/json

Body

required

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

Responses

200

Agent updated or created successfully

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

400

Invalid character configuration

application/json

Schema

Schema

successboolean
Example: false
messagestring

Example (from schema)

{
  "success": false,
  "message": "string"
}

500

Error starting agent

application/json

Schema

Schema

successboolean
Example: false
messagestring

Example (from schema)

{
  "success": false,
  "message": "string"
}