Authentication
How to issue API keys and authenticate every request, plus the difference between live and test keys.
The Pixii API uses API keys to authenticate all requests. Keep your API keys secure. Do not share them in public repositories or client-side code.
Generating an API key
API access is currently available to early partners. Contact us to get your API key. We’ll get you set up within 24 hours.
Making authenticated requests
Pixii uses Bearer token authentication. Pass your API key in the Authorization header of every request.
A missing or invalid API key returns a 401 Unauthorized response with error code UNAUTHORIZED.
Live vs test keys
Pixii provides two types of API keys, identifiable by their prefix:
| Live key | Test key | |
|---|---|---|
| Prefix | pk_live_ | pk_test_ |
| Jobs | Real, runs the full pipeline | Mock, completes instantly with placeholder data |
| Credits | Consumed | Never consumed |
| Rate limits | Enforced | Not enforced |
| Response time | Minutes | Under 1 second |
| Use for | Production | Development and testing |
Mock responses match the exact shape of a real response, same fields and same structure, but contain placeholder image and zip URLs instead of real generated visuals. A test job is created as completed immediately, so the Jobs API returns its output on the first poll. This lets you build and test your integration end to end without waiting for real jobs or spending credits.
Real responses run the full Pixii pipeline: your product is fetched and analyzed, visuals are generated and uploaded, and you receive URLs to the generated visuals.
Use test keys during development
Always use your test key (pk_test_) while building your integration. Switch to your live key (pk_live_) only when you are ready to go to production.