API overview
SubQ provides an OpenAI-compatible API.
Existing Chat Completions clients can switch by changing the base URL and API
key, then passing the subq-preview model ID in the request body.
Request flow
Section titled “Request flow”- Create an account at console.subq.ai
- Generate an API key from the console
- Set the SubQ base URL in your HTTP client or OpenAI SDK
- Send a Chat Completions request using SubQ.
- Enable streaming when your product needs tokens as they are generated
Base URL
Section titled “Base URL”Send API requests to:
https://api.subq.ai/v1The documented endpoints use OpenAI-compatible request and response shapes. Treat the pages in this documentation as the contract for the supported model, fields, and response formats.
Next steps
Section titled “Next steps”- Use the Quickstart to verify your API key with
curl. - Read Authentication before wiring credentials into an app.
- Review SubQ capabilities in Models.
- Build against the Chat Completions API.