Mindforge Docs

Appearance

Characters API ​

The Character object ​

json
{
  "id": "string", // string
  "createdAt": "string", // string
  "projectId": "string", // string
  "name": "string", // string
  "description": "string | null", // string | null
  "capabilities": [] // Capability[]
}

Create a character ​

POST https://api.mindforge.ai/characters

Example ​

sh
curl -X POST https://api.mindforge.ai/characters \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example Character",
    "description": "This is an example description for the character."
  }'

Update a character ​

PATCH https://api.mindforge.ai/characters/<characterId>

Example ​

sh
curl -X PATCH https://api.mindforge.ai/characters/character_OCMoSjairVVhUpCB \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example Character",
    "description": "This is an example description for the character."
  }'

Retrieve a character ​

GET https://api.mindforge.ai/characters/<characterId>

Example ​

sh
curl https://api.mindforge.ai/characters/character_OCMoSjairVVhUpCB

List all characters ​

GET https://api.mindforge.ai/characters

Example ​

sh
curl https://api.mindforge.ai/characters

Delete a character ​

DELETE https://api.mindforge.ai/characters/<characterId>

Example ​

sh
curl -X DELETE https://api.mindforge.ai/characters/character_OCMoSjairVVhUpCB

Add a capability to a character ​

POST https://api.mindforge.ai/characters/<characterId>/capabilities

Example ​

sh
curl -X POST https://api.mindforge.ai/characters/character_OCMoSjairVVhUpCB/capabilities \
  -H "Content-Type: application/json" \
  -d '{
    "capabilityId": "capability_5X51Einm2JqPi53D"
  }'

Remove a capability from a character ​

DELETE https://api.mindforge.ai/characters/<characterId>/capabilities/<capabilityId>

Example ​

sh
curl -X DELETE https://api.mindforge.ai/characters/character_OCMoSjairVVhUpCB/capabilities/capability_5X51Einm2JqPi53D