Convai

Convai Chat History API

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

GitHub OpenAPI

Operations 2

POST /character/chat-history/list-sessions List Character Sessions #
POST /character/chat-history/get-session Get Session Transcript #

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://artifacts.apis.io/convai-com/openapi/convai-com-chat-history-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/convai-com/json-schema/convai-character-schema.json
📊
JSONSchema
https://artifacts.apis.io/convai-com/json-schema/convai-interaction-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/convai-com/json-ld/convai-context.jsonld

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:convai-com-chat-history-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

convai-com-chat-history-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Convai Chat History API
  version: '1.0'
  description: 'Retrieve historical conversation sessions and full interaction transcripts

    for Convai characters. Used for analytics, debugging, evaluation, and

    auditing of NPC conversations. Scale tier and above.'
servers:
- url: https://api.convai.com
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