How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Convai Interaction API

The Interaction API from Convai — 1 operation(s) for interaction.

Convai Interaction API is one of 10 APIs that Convai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Interaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.convai.com.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Server
https://api.convai.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Convai Interaction API declares 1 security scheme for authenticating requests. An API key is passed in the header as CONVAI-API-KEY (ConvaiApiKey). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Interaction 1
POST
/character/getResponse
Get Character Response
getCharacterResponse body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are GetResponseResponse (6 properties), GetResponseRequest (5 properties). Each schema is shown below with its type and property counts.

GetResponseResponse
object
6 properties
GetResponseRequest
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convai-com-interaction-api-openapi.yml Raw ↑

Other APIs Convai publishes across the network.

Convai Characters API
Convai Chat History API
Convai Custom LLM API
Convai Evaluation API
Convai Knowledge Bank API
Convai Live API
Convai Narrative API
Convai Streaming API
Convai TTS API
Where this information came from

This is an independent, third-party profile of Convai Interaction API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.