AI Chatbot API

Create character

POST /api/v11/character

Upload character data to our system

Headers

  • x-access-token string Required
application/json

Body

  • name string Required
  • description string Required
  • aiPrompt string Required
  • initialResponse string Required
  • banner string Required

    base64-encoded AVIF image

  • icon string Required

    base64-encoded AVIF image

  • isPrivate boolean Required
  • specialMessages array[object] Required
    Hide specialMessages attributes Show specialMessages attributes object
    • startsWith string Required
    • endsWith array[string] Required
    • prompt string Required

Responses

  • 200 application/json

    Character was created successfully

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is true.

    • characterId integer Required
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is false.

    • error string Required

      Value is One or more API parameters are malformed. Please check your request and try again.
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is false.

    • error string Required

      Value is Invalid username, password, or access token.
  • 429 application/json

    User exceeded the message limit for their current plan

    One of:
    object-2 object object-2 object
POST /api/v11/character 
curl \
 --request POST 'https://chat-api.aurora-interactive.online:8443/api/v11/character' \
 --header "Content-Type: application/json" \
 --header "x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf" \
 --data '{"name":"string","description":"string","aiPrompt":"string","initialResponse":"string","banner":"AAAAbx","icon":"AAAAbx","isPrivate":true,"specialMessages":[{"startsWith":"string","endsWith":["string"],"prompt":"string"}]}'
Request examples 
# Headers
x-access-token: wcdE8dGPZEshG6B8E5uGpgALr5LzwPX5AqZFKAZsfcvzuHVf

# Payload
{
  "name": "string",
  "description": "string",
  "aiPrompt": "string",
  "initialResponse": "string",
  "banner": "AAAAbx",
  "icon": "AAAAbx",
  "isPrivate": true,
  "specialMessages": [
    {
      "startsWith": "string",
      "endsWith": [
        "string"
      ],
      "prompt": "string"
    }
  ]
}
Response examples (200) 
{
  "success": true,
  "characterId": 42
}
Response examples (400) 
{
  "success": false,
  "error": "One or more API parameters are malformed. Please check your request and try again"
}
Response examples (401) 
{
  "success": false,
  "error": "Invalid username, password, or access token"
}
Response examples (429) 
{
  "success": false,
  "error": "You have exceeded your Message/TTS quota. To send more messages, please upgrade your plan or wait until your subscription renews."
}
{
  "statusCode": 42,
  "error": "string",
  "message": "string"
}