API overview
Copy Page as Markdown
SubQ provides three inference endpoints: Decisions, Chat Completions, and Responses, plus resources for managing conversations, files, and models. Chat Completions and Responses are OpenAI-compatible. Decisions has a separate, typed JSON contract.
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
- Choose an endpoint and send a request using a SubQ model.
- Enable streaming on Chat Completions or Responses when your product needs tokens as they are generated
Base URL
Send API requests to:
https://api.subq.ai/v1Treat each endpoint page as the contract for its supported models, fields, and response formats.
Endpoints
| Endpoint | Method | Path | Use it to |
|---|---|---|---|
| Models | GET | /v1/models | List the model IDs available to your API key at runtime. |
| Decisions | POST | /v1/systemone | Return typed yes/no, choice, and score decisions about text or images, with probabilities and confidence. |
| Responses | POST | /v1/responses | Run multi-turn and long-context workflows with instructions, built-in web search, and server-side history via previous_response_id. |
| Chat Completions | POST | /v1/chat/completions | Generate text from messages, statelessly. The drop-in path for OpenAI migrations. |
| Files | POST / GET / DELETE | /v1/files | Upload documents once and reference them by file_id in Chat Completions or Responses. |
| Conversations | POST / GET / DELETE | /v1/conversations | Create, inspect, retag, and delete a conversation's history, independent of any single turn. |
Next steps
- Use the Quickstart to verify your API key.
- Read Authentication before wiring credentials into an app.
- Review SubQ capabilities in Models.
- Return typed decisions with the Decisions API.
- Put documents in a prompt with Sending files.
- Return schema-constrained JSON with Structured outputs.
- Connect models to your app with Function calling.
- Check Data retention for how long SubQ stores your prompts and completions.