API reference
The reference covers SDK exports and the public HTTP specifications: methods, parameters, request bodies, response statuses and schemas. Start with a workflow guide for authentication, setup and recovery; use these pages for exact signatures and request/response shapes.
- Admin HTTP API
- Admin SDK
- API schema
- Client SDK
- Customer HTTP API
- Protocols and permissions
- Self-hosted app server SDK
Choose an integration
- Client SDK guide: customer sessions, chat, models, usage and purchases.
- Admin SDK guide: server-side project, product, customer and credential administration.
- Self-hosted server guide: application-server routes, resumable chats and Vercel AI SDK adapters.
- REST API guide: HTTP authentication, request and response envelopes, endpoint coverage and errors.
Each package reference identifies its source version. Local source changes may precede a published release.
Last updated on