Getting started
Base URL, transport, authentication and error handling. Everything you need to make your first call.
REST over HTTPS
Pixii’s API is built using REST. Requests use standard HTTP verbs, return JSON, and must always be made over HTTPS.
Base URL
All API requests are made to the following base URL:
https://api.pixii.ai/v2/apiAll requests must use HTTPS. Plain HTTP requests are rejected.
Authentication
The Pixii API uses API keys to authenticate requests.
Pass your API key in the Authorization header of every request as a Bearer token. See Authentication for the full guide, including the difference between live and test keys.
Plans
What an endpoint may do depends on your Pixii plan, exactly as in the app.
| Plan | Endpoints |
|---|---|
| Free | Brands, Create listing, Create anything (every deliverable except A+ Content), Creative strategy, Download visuals, Jobs, Usage |
| Paid plans | Everything above, plus A+ Content and Scale with one product per run |
| Scale plan | Everything above, plus Scale with up to 50 products per run |
A refused request returns 402 with PAID_PLAN_REQUIRED or PLAN_LIMIT_REACHED. See errors.
Error handling
Pixii uses conventional HTTP response codes to indicate the success or failure of an API request:
- Codes in the 2xx range indicate success.
- Codes in the 4xx range indicate an error with the information you provided.
- Codes in the 5xx range indicate an error with Pixii’s servers.
Every error response is JSON with a consistent shape so you can handle errors programmatically. See the errors reference for the full list of codes.
Next
Continue to Authentication to learn how to issue and use your API keys.