Convai

Convai Evaluation API

Score and evaluate Convai character sessions against a custom prompt and rubric variables. Used to measure NPC quality, role fidelity, safety, and objective completion. Professional tier and above.

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

This API exposes 1 machine-runnable capability that can be deployed as REST, MCP, or Agent Skill surfaces via Naftiko.

Tagged areas include AI, Conversational AI, Evaluation, and Quality. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 Naftiko capability spec.

Documentation GitHub OpenAPI

Documentation

https://docs.convai.com/api-docs/api-reference/core-api-reference

Specifications

https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/openapi/convai-evaluation-api-openapi.yml

Other Resources

NaftikoCapability

https://raw.githubusercontent.com/api-evangelist/convai-com/refs/heads/main/capabilities/evaluation-evaluation.yaml

OpenAPI Specification

openapi: 3.1.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: []
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