How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Percy Snapshots API

Snapshots are the individual visual comparisons within a build.

Percy Snapshots API is one of 4 APIs that Percy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Snapshots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://percy.io/api/v1.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://percy.io/api/v1
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Percy Snapshots API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (projectToken). It accepts HTTP basic authentication (browserstackBasic). By default, every request must be authenticated.

  • projectToken — Per-project token passed in the Authorization header using Percy's token scheme - literally Authorization: Token token= . Because the value is prefixed with To…
  • browserstackBasic — BrowserStack HTTP Basic auth (base64 of username:accesskey). Required for review actions and for creating or updating projects.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Snapshots 2

Snapshots are the individual visual comparisons within a build.

GET
/snapshots
List snapshots for a build
listSnapshots 6 params → 200401
GET
/snapshots/{snapshot_id}
Get snapshot details
getSnapshot 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Snapshot (3 properties), SnapshotListResponse (1 property), SnapshotResponse (1 property), Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property
Snapshot
object
A Percy snapshot - one visual comparison within a build.
3 properties
SnapshotResponse
object
1 property
SnapshotListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

percy-snapshots-api-openapi.yml Raw ↑

Other APIs Percy publishes across the network.

Percy Builds API
Percy Projects API
Percy Visual Git API
Where this information came from

This is an independent, third-party profile of Percy Snapshots API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.