Convai

Convai Evaluation API

The Evaluation API from Convai — 1 operation(s) for evaluation.

GitHub OpenAPI

Operations 1

POST /evaluation/evaluate-session Evaluate Session #

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-evaluation-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-evaluation-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-evaluation-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Convai Evaluation API
  version: '1.0'
  description: 'Score and evaluate Convai character sessions against custom prompts and

    rubric variables. Used to measure NPC quality, role-fidelity, safety, and

    objective completion. Professional tier and above.

    '
servers:
- url: https://api.convai.com
security:
- ConvaiApiKey: []
tags:
- name: Evaluation
paths:
  /evaluation/evaluate-session:
    post:
      summary: Evaluate Session
      operationId: evaluateSession
      tags:
      - Evaluation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - session_id
              - character_id
              - prompt
              properties:
                session_id:
                  type: string
                character_id:
                  type: string
                prompt:
                  type: string
                  description: Evaluation rubric / scoring instructions
                variables:
                  type: object
                  additionalProperties: true
      responses:
        '200':
          description: Evaluation result
          content:
            application/json:
              schema:
                type: object
                properties:
                  score:
                    type: number
                  reasoning:
                    type: string
                  variables:
                    type: object
                    additionalProperties: true
components:
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY