Reference

PyAI API reference: error codes and
streaming frames

The exact strings you branch on, each as its own searchable anchor. The full machine-readable contract lives in the OpenAPI spec.

Error codes

Every stable error.code in the OpenAI-shaped envelope - 10 codes with HTTP status and how to react. Branch on the code, not the message.

Open

Streaming frames

The Hear streaming STT wire protocol - 5 server frame types plus the client control frames and close codes, each its own anchor.

Open

OpenAPI spec Full docs llms-full.txt

Tip

Looking for one string? Deep-link straight to it, e.g. /reference/errors#rate_limit_exceeded or /reference/streaming-frames#speech_final.

QUESTIONS, ANSWERED

A few useful answers.

What is covered in this API reference?

This reference explains stable error codes and Hear streaming frames. Use the full OpenAPI contract and canonical documentation for complete endpoint and request details.

Where should my integration start?

Choose the product workflow, read its documentation and inspect the live API contract. Use the SDK starters when you want a complete project with setup instructions.

How should I handle a response I do not recognize?

Retain the response and request context, consult the documented error or event contract, and handle unsupported values safely instead of assuming that every response has the same shape.

Build against the real contract.

Start free with $50 in free credits - the OpenAPI spec and llms-full.txt keep your agent honest.

Get API Key