Overview
The Plannix REST API is compatible with the OpenAI REST API. This reference is generated from the OpenAPI specification and organised by resource.
Base URLs and authentication
Plannix provides dedicated, high-availability endpoints partitioned between public inference workloads and high-privilege organizational management operations.
| API | Base URL | Authenticate with |
|---|---|---|
| Inference responses, chat completions, images, videos, voice, files, batches, models | https://api.plannix.web.id | Authorization: Bearer <Plannix API key> |
| Collections management | https://management-api.plannix.web.id | Authorization: Bearer <Plannix Management API key> |
| Collections search | https://api.plannix.web.id | Authorization: Bearer <Plannix API key> |
| Management API keys, teams, billing, audit | https://management-api.plannix.web.id | Authorization: Bearer <Plannix Management API key> |
Standard request headers
Every HTTP request must include an Authorization header bearing your active API key.
HTTP Request Headershttp
Authorization: Bearer ${PLANNIX_API_KEY}
Content-Type: application/json
User-Agent: plannix-node-sdk/1.4.0Error codes and responses
When an error occurs, Plannix returns standard HTTP status codes along with a JSON error payload containing a machine-readable code and explanatory message:
JSON Error Responsejson
{
"error": {
"message": "Invalid API key provided or key expired.",
"type": "invalid_request_error",
"code": "invalid_api_key",
"param": null
}
}Rate limits and headers
Responses include informative HTTP headers indicating your remaining quotas and reset windows:
| Header | Description |
|---|---|
x-ratelimit-limit-requests | The maximum number of requests allowed per minute in your current tier. |
x-ratelimit-remaining-requests | The number of requests remaining in the current minute window. |
x-ratelimit-reset-requests | The time remaining (e.g. 2.4s) until the current window resets. |