Convai

Convai Live API

The Live API from Convai — 1 operation(s) for live.

GitHub OpenAPI

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-live-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

OpenAPI Specification

convai-com-live-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Convai Character Characters Live 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: Live
paths:
  /connect:
    post:
      summary: Connect Live Session
      operationId: connectLiveSession
      tags:
      - Live
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              properties:
                character_id:
                  type: string
                session_id:
                  type: string
                debug:
                  type: boolean
                  description: Enable metrics events on the data channel
                  default: false
                audio_config:
                  type: object
                  properties:
                    output:
                      type: object
                      properties:
                        audio_routing:
                          type: string
                          enum:
                          - media
                          - data-channel
      responses:
        '200':
          description: Connection params (SDP, ICE servers, room info)
          content:
            application/json:
              schema:
                type: object
                properties:
                  room_url:
                    type: string
                    format: uri
                  token:
                    type: string
                  sdp:
                    type: string
components:
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY