# Chromatic Builds API

**Canonical:** https://apis.io/apis/chromatic/chromatic-builds-api/  
**Provider:** Chromatic — https://apis.io/providers/chromatic/  
**Base URL:** https://index.chromatic.com/graphql  
**Documentation:** https://www.chromatic.com/docs/cli/

Chromatic Builds API is one of 4 APIs that [Chromatic](https://apis.io/providers/chromatic/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Visual Testing, Visual Regression, Builds, and Snapshots. The published artifact set on APIs.io includes API documentation.

Query builds produced by the Chromatic CLI - the `build(id)` and `project.lastBuild(...)` GraphQL fields expose build number, status (IN_PROGRESS, PASSED, PENDING, ACCEPTED, DENIED, BROKEN, FAILED), result, browsers, Git commit/branch/slug, component and story counts, published Storybook URLs, and snapshot capture timings. This is the surface the CLI and Storybook Visual Tests addon use to initialize and poll visual-testing builds.

## Machine-readable artifacts (6)

- **Documentation** — https://www.chromatic.com/docs/cli/
- **GraphQL** — https://raw.githubusercontent.com/api-evangelist/chromatic/refs/heads/main/graphql/chromatic-public-schema.graphql
- **GraphQL** — https://raw.githubusercontent.com/api-evangelist/chromatic/refs/heads/main/graphql/chromatic-graphql.md
- **OpenCollection** — https://raw.githubusercontent.com/api-evangelist/chromatic/refs/heads/main/collections/chromatic.opencollection.json
- **PostmanCollection** — https://raw.githubusercontent.com/api-evangelist/chromatic/refs/heads/main/collections/chromatic.postman_collection.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/chromatic/refs/heads/main/apis.yml

## Other Chromatic APIs (3)

- [Chromatic Tests and Review API](https://apis.io/apis/chromatic/chromatic-tests-review-api/)
- [Chromatic Projects and Accounts API](https://apis.io/apis/chromatic/chromatic-projects-accounts-api/)
- [Chromatic Storybook and Stories API](https://apis.io/apis/chromatic/chromatic-storybook-stories-api/)

## Tags

Visual Testing, Visual Regression, Builds, Snapshots

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/chromatic/chromatic-builds-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/chromatic/.