Convai

Convai Chat History API

The Chat History API from Convai — 2 operation(s) for chat history.

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-chat-history-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-chat-history-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Convai Character Characters Chat History 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: Chat History
paths:
  /character/chat-history/list-sessions:
    post:
      summary: List Character Sessions
      operationId: listSessions
      tags:
      - Chat History
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - charID
              properties:
                charID:
                  type: string
                limit:
                  type: integer
                  default: 50
      responses:
        '200':
          description: Session list
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    sessionID:
                      type: string
                    startTime:
                      type: string
                      format: date-time
                    duration:
                      type: integer
                    messageCount:
                      type: integer
  /character/chat-history/get-session:
    post:
      summary: Get Session Transcript
      operationId: getSession
      tags:
      - Chat History
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - charID
              - sessionID
              properties:
                charID:
                  type: string
                sessionID:
                  type: string
      responses:
        '200':
          description: Session transcript
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionID:
                    type: string
                  interactions:
                    type: array
                    items:
                      type: object
                      properties:
                        role:
                          type: string
                          enum:
                          - user
                          - character
                        text:
                          type: string
                        timestamp:
                          type: string
                          format: date-time
components:
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY