API setup guide
Bring models into your workflow, starting with the right endpoint.
Choose your client
Console entry points. Copy the actual Base URL from your delivery details; the console URL is not necessarily the API endpoint.
Before you connect
After purchasing an API service, check the following details in your delivery instructions. Web subscriptions do not include API credits unless the product page says otherwise.
| Setting | Purpose |
|---|---|
| Base URL | The endpoint supplied in your delivery instructions, not this website's address |
| API key | Access to the API service you purchased |
| Model identifier | The model name to use in requests |
| Protocol and path | Confirm the OpenAI-compatible or corresponding Claude interface |
| Billing and limits | Check credits, rate limits, context limits, and billing rules |
Configure your development tools
Enter the supplied endpoint, key, and model identifier in your tool's model provider settings. Test the connection with a simple request containing no sensitive information before enabling your everyday workflow.
The example below only shows how to organize environment variables. Replace all example values with the details supplied to you. This is not a working endpoint.
export SUPAKOOK_BASE_URL="replace-with-your-supplied-endpoint"
export SUPAKOOK_API_KEY="replace-with-your-api-key"
export SUPAKOOK_MODEL="replace-with-your-supplied-model-identifier"
Tools differ in whether the Base URL should include a version path. Follow your tool's documentation and the service delivery instructions. Never put keys in website frontend code, public repositories, or screenshots.
Request compatibility and reliability
The service aims to align with official request fields and maintain spare backend capacity. Check the documentation for the interface you purchased to confirm support for fields, tool calls, streaming output, and model versions.
Spare capacity cannot prevent every interruption. Networks, official service availability, rate limits, and account status can all affect individual requests. Production workflows should use reasonable timeouts, a limited number of retries, and clear failure messages.
Troubleshoot common errors
- 401 / 403: Check that the key is correct, valid, and authorized for the service. Do not send anyone your complete key.
- 404: Check the endpoint path and model identifier. Make sure your development tool is not adding the version path twice.
- 429: Check your balance, usage allowance, and rate limits. Reduce concurrency and retry as directed by the service documentation.
- 5xx / timeout: Record the time, request ID if available, and error details with sensitive information removed. Avoid unlimited retries.
For help, send the product name, tool version, and steps to reproduce the issue with sensitive information removed through your original order channel.