Convai

Convai Streaming API

The Streaming API from Convai — 1 operation(s) for streaming.

GitHub OpenAPI

Operations 1

GET /stream Open Streaming Transcription WebSocket #

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-streaming-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-streaming-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-streaming-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Convai Transcription Streaming API
  version: '1.0'
  description: 'Real-time speech-to-text over a WebSocket connection. Stream 16-bit PCM,

    mono, 16 kHz audio and receive incremental transcripts. Used by the Convai

    plugins to drive low-latency voice input from players. Endpoint is

    documented here as an OpenAPI definition for discoverability; the live

    transport is wss://transcribe.convai.com/stream.

    '
servers:
- url: https://transcribe.convai.com
security:
- ConvaiApiKey: []
tags:
- name: Streaming
paths:
  /stream:
    get:
      summary: Open Streaming Transcription WebSocket
      operationId: openTranscriptionStream
      tags:
      - Streaming
      description: 'Upgrade to WebSocket. Send 16-bit PCM, mono, 16 kHz audio binary

        frames. Receive JSON transcript frames with `text`, `is_final`, and

        `confidence`. Authentication via `CONVAI-API-KEY` header or

        `?convai-api-key=` query parameter.

        '
      parameters:
      - in: query
        name: convai-api-key
        schema:
          type: string
        description: Optional alternative to the header auth
      responses:
        '101':
          description: Switching Protocols (WebSocket upgrade)
components:
  securitySchemes:
    ConvaiApiKey:
      type: apiKey
      in: header
      name: CONVAI-API-KEY