Convai · Schema

Convai Character

A Convai conversational AI character — a reusable agent with voice, backstory, language, personality, knowledge bank, and narrative configuration.

Artificial IntelligenceConversational AICharactersNPCsVirtual WorldsGamesAvatarsSpeechText-to-SpeechWebRTC

Properties

Name Type Description
charID string Convai character identifier
charName string Display name of the character
voiceType string Voice identifier from the Convai voice catalog
backstory string Free-form backstory text shaping the character's identity, role, and behaviour
language string BCP-47 style language code, e.g. en-us
timezone string IANA timezone for the character
isNarrativeDriven boolean Whether the character runs in narrative-driven mode with sections and triggers
knowledgeBank array Optional list of attached knowledge bank documents
personality object Personality and state-of-mind settings
timestamp string
View JSON Schema on GitHub

JSON Schema

convai-character-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/convai-com/main/json-schema/convai-character-schema.json",
  "title": "Convai Character",
  "description": "A Convai conversational AI character — a reusable agent with voice, backstory, language, personality, knowledge bank, and narrative configuration.",
  "type": "object",
  "required": ["charID", "charName"],
  "properties": {
    "charID": {
      "type": "string",
      "description": "Convai character identifier"
    },
    "charName": {
      "type": "string",
      "description": "Display name of the character"
    },
    "voiceType": {
      "type": "string",
      "description": "Voice identifier from the Convai voice catalog"
    },
    "backstory": {
      "type": "string",
      "description": "Free-form backstory text shaping the character's identity, role, and behaviour"
    },
    "language": {
      "type": "string",
      "description": "BCP-47 style language code, e.g. en-us"
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone for the character"
    },
    "isNarrativeDriven": {
      "type": "boolean",
      "description": "Whether the character runs in narrative-driven mode with sections and triggers"
    },
    "knowledgeBank": {
      "type": "array",
      "description": "Optional list of attached knowledge bank documents",
      "items": {
        "type": "object",
        "properties": {
          "document_id": { "type": "string" },
          "file_name": { "type": "string" },
          "status": { "type": "string" }
        }
      }
    },
    "personality": {
      "type": "object",
      "description": "Personality and state-of-mind settings",
      "additionalProperties": true
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": true
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/convai-character"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.