Convai

Convai Knowledge Bank API

The Knowledge Bank API from Convai — 4 operation(s) for knowledge bank.

GitHub OpenAPI

Operations 4

POST /character/knowledge-bank/upload Upload Knowledge Bank Document #
POST /character/knowledge-bank/update Update Knowledge Bank Document #
POST /character/knowledge-bank/list List Knowledge Bank Documents #
POST /character/knowledge-bank/delete Delete Knowledge Bank Document #

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-knowledge-bank-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

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-knowledge-bank-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-knowledge-bank-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Convai Knowledge Bank API
  version: '1.0'
  description: 'Manage retrieval-augmented knowledge documents attached to Convai

    characters. Upload PDFs, text, and other docs that characters will

    reference when generating responses. Enterprise tier.

    '
servers:
- url: https://api.convai.com
security:
- ConvaiApiKey: []
tags:
- name: Knowledge Bank
paths:
  /character/knowledge-bank/upload:
    post:
      summary: Upload Knowledge Bank Document
      operationId: uploadKnowledgeBank
      tags:
      - Knowledge Bank
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file_name
              - file
              - character_id
              properties:
                file_name:
                  type: string
                file:
                  type: string
                  format: binary
                character_id:
                  type: string
      responses:
        '200':
          description: Document uploaded
          content:
            application/json:
              schema:
                type: object
                properties:
                  document_id:
                    type: string
  /character/knowledge-bank/update:
    post:
      summary: Update Knowledge Bank Document
      operationId: updateKnowledgeBank
      tags:
      - Knowledge Bank
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - document_id
              - character_id
              properties:
                document_id:
                  type: string
                character_id:
                  type: string
                docs:
                  type: string
      responses:
        '200':
          description: Updated
  /character/knowledge-bank/list:
    post:
      summary: List Knowledge Bank Documents
      operationId: listKnowledgeBank
      tags:
      - Knowledge Bank
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - character_id
              properties:
                character_id:
                  type: string
      responses:
        '200':
          description: Document list
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    document_id:
                      type: string
                    file_name:
                      type: string
                    status:
                      type: string
  /character/knowledge-bank/delete:
    post:
      summary: Delete Knowledge Bank Document
      operationId: deleteKnowledgeBank
      tags:
      - Knowledge Bank
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - document_id
              - character_id
              properties:
                document_id:
                  type: string
                character_id:
                  type: string
      responses:
        '200':
          description: Deleted
components:
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY