Skip to main content
Table of Contents


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

Note: API base URL

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

Note: Authorization header format
Authorization: Token ${PERCY_TOKEN}

Percy currently authenticates with three project token types:

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

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

Percy Token

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

Thank you for your valuable feedback