Authentication

The Pixel Systems API uses API Key authentication for server-side requests.

Access the API

Include your API key in the Authorization header of every request:

Authorization: Bearer {api_key}

For example, calling List jobs (/v1/jobs):

curl -X GET "https://api.pixelsystems.com/v1/jobs?applicationId={application_id}" \
  -H "Authorization: Bearer {api_key}"

Make all requests over HTTPS. A request with a missing or invalid key returns 401 with the error code unauthorized; see error codes.

API keys

API keys are scoped to an application: a key authorizes requests for its application only.

To get access, contact us or book a demo and we set up your organization. From there, API keys are self-serve for organization admins: create an application in the dashboard (or open an existing one), then create or revoke its API keys.

Keep your keys safe

API keys are secrets

A key authorizes every operation on its application, so treat it like a password.

  • Use keys on servers only. Never embed one in browser code, a mobile app, or version control; for uploads from the browser, use the client SDK or the no-code option instead.
  • Store keys in environment variables or a secrets manager, not in source code.
  • If a key leaks, revoke it in the dashboard and create a new one. Revoking is self-serve for organization admins.