Convai

Convai Characters API

The Characters API from Convai — 6 operation(s) for characters.

GitHub OpenAPI

Operations 6

POST /character/create Create Character #
POST /character/get Get Character #
POST /character/update Update Character #
POST /character/list List Characters #
POST /character/delete Delete Character #
POST /user/clone_character Clone Character #

Documentation

📖
Documentation
https://docs.convai.com/api-docs/api-reference/core-api-reference
📖
Documentation
https://docs.convai.com/api-docs/api-reference/live-api-reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/openapi/convai-com-characters-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/json-schema/convai-character-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/json-schema/convai-interaction-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/json-ld/convai-context.jsonld
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/apis.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/convai-com-characters-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

convai-com-characters-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Convai Character Characters API
  version: '1.0'
  description: 'REST API for creating, listing, updating, cloning, and deleting Convai

    conversational AI characters. Characters are reusable conversational agents

    with backstory, voice, personality, language, and knowledge configuration

    that can be embodied in games, virtual worlds, and 3D experiences via the

    Unity, Unreal, Web, and other Convai SDKs.

    '
  contact:
    name: Convai Developer Support
    url: https://forum.convai.com
servers:
- url: https://api.convai.com
  description: Convai REST API
security:
- ConvaiApiKey: []
tags:
- name: Characters
paths:
  /character/create:
    post:
      summary: Create Character
      operationId: createCharacter
      tags:
      - Characters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CharacterCreateRequest'
      responses:
        '200':
          description: Character created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CharacterCreateResponse'
  /character/get:
    post:
      summary: Get Character
      operationId: getCharacter
      tags:
      - Characters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - charID
              properties:
                charID:
                  type: string
      responses:
        '200':
          description: Character details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Character'
  /character/update:
    post:
      summary: Update Character
      operationId: updateCharacter
      tags:
      - Characters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CharacterUpdateRequest'
      responses:
        '200':
          description: Character updated
  /character/list:
    post:
      summary: List Characters
      operationId: listCharacters
      tags:
      - Characters
      responses:
        '200':
          description: List of characters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Character'
  /character/delete:
    post:
      summary: Delete Character
      operationId: deleteCharacter
      tags:
      - Characters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - charID
              properties:
                charID:
                  type: string
      responses:
        '200':
          description: Character deleted
  /user/clone_character:
    post:
      summary: Clone Character
      operationId: cloneCharacter
      tags:
      - Characters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - charID
              properties:
                charID:
                  type: string
      responses:
        '200':
          description: Character cloned
components:
  schemas:
    CharacterCreateRequest:
      type: object
      required:
      - charName
      - voiceType
      - backstory
      properties:
        charName:
          type: string
        voiceType:
          type: string
          description: Voice identifier from the Voice List API
        backstory:
          type: string
        language:
          type: string
          default: en-us
        timezone:
          type: string
    CharacterUpdateRequest:
      type: object
      required:
      - charID
      properties:
        charID:
          type: string
        charName:
          type: string
        voiceType:
          type: string
        backstory:
          type: string
        language:
          type: string
    Character:
      type: object
      properties:
        charID:
          type: string
        charName:
          type: string
        voiceType:
          type: string
        backstory:
          type: string
        language:
          type: string
        timestamp:
          type: string
          format: date-time
    CharacterCreateResponse:
      type: object
      properties:
        charID:
          type: string
        status:
          type: string
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY