Skip to content
Pixii
Login

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

All 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.

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.