Authentication

The Percy API is based on the JSON API standard and organized around the REST design.

📘
API base URL
https://percy.io/api/v1

The Percy API uses API tokens to authenticate. They are passed in as a HTTP Authorization request headers.

📘
Authorization header format
Authorization: Token ${PERCY_TOKEN}

Percy currently authenticates with three project token types:

The differences are outlined below:

Write-only	Read-only	Full-access
- Create builds - Create snapshots - SDK use	- Read builds - Download snapshots - API use	All project read and write functions

The tokens for a particular project can be found on its Project Settings page.