Guides
OpenAI Compatibility Matrix
Distinguish confirmed, partially compatible, and unconfirmed OpenAI endpoints, parameters, message roles, and response fields.
APIQIK confirms compatibility with the core OpenAI Chat Completions request and response structures. Compatibility means common SDK calling patterns can be reused, not that every OpenAI endpoint, parameter, or model capability is identical.
Endpoint status
| Endpoint or capability | Status | Notes |
|---|---|---|
POST /v1/chat/completions | Core compatibility confirmed | Standard authentication, messages, common generation parameters, non-streaming, and streaming. |
Tool calling with tools | Model-dependent | Uses an OpenAI-style request; verify the target model's capabilities in the catalog. |
| Vision messages, JSON mode, reasoning fields | Model-dependent / partial | Parameters and response fields can vary by upstream model. |
GET /v1/models | Core compatibility confirmed | Returns { object: "list", data: [{ id, object, created, owned_by }] }; take model names from data[].id; created is a fixed value. Authenticate with a valid API key using Authorization: Bearer <API_KEY>; missing or invalid keys return 401. Use the unauthenticated /v1/public/models endpoint for catalog filters and pagination. |
| Embeddings, Images, Audio, Files, Batch, Moderations | Pending platform confirmation | An SDK method does not prove APIQIK support. |
| Responses, Assistants, Realtime, Fine-tuning | Not promised | No compatibility commitment in the current documentation. |
Chat Completions core fields
| Category | Confirmed / current baseline | Confirm by model |
|---|---|---|
| Message roles | system, user, assistant, tool | developer and provider-specific roles. |
| Generation parameters | model, messages, temperature, max_tokens, stream | seed, logprobs, audio output, and provider-specific options. |
| Tool fields | tools, tool_choice, tool_calls | Parallel tools, strict schemas, and custom tool types. |
| Streaming fields | choices[].delta, finish_reason, terminal events | Exact stream_options and streaming usage behavior. |
| Response objects | id, choices, usage | Cached tokens, reasoning tokens, and provider metadata. |
SDK validation baseline
- Use the current Python
openaiclient'sOpenAI(...)initialization. - Use the current Node.js
openaiclient'snew OpenAI(...)initialization. - Record validated SDK versions and dates for APIQIK releases, and rerun examples after upgrades.
- Ignore unknown response fields and handle optional fields as nullable.
Migration rule: Validate the endpoint and model with a minimal request, then add streaming, tools, multimodal input, and structured parameters one at a time. Do not assume all advanced parameters are compatible.