Upload from CI
Argos-compatible API
Point the Argos SDKs at CirCI by changing two variables, designed to work and not yet verified with the real SDKs.
CirCI accepts uploads from the Argos SDKs under /v2, so a project that uploads with @argos-ci/playwright, @argos-ci/cypress, @argos-ci/storybook or @argos-ci/cli can switch by changing two values:
ARGOS_API_BASE_URL=https://ci.acme.io/v2ARGOS_TOKEN=circi_… # the project's CI tokencirci argos-env prints exactly these two lines from CIRCI_API_URL and CIRCI_TOKEN.
What works
Section titled “What works”- Project lookup, baseline lookup from the commit history the SDK collected, build creation, the file upload target, updates in chunks, parallel builds (
parallel,parallelNonce,parallelIndex,parallelTotal) and build names. - The history the SDK collected finds the baseline. The build's Details tab shows it as "where this branch started".
- Pull request number, branch, and reference branch and commit.
What doesn't
Section titled “What doesn't”- PNG only. An SDK sending JPEG is refused.
- Traces, per-screenshot thresholds,
parentNameandbaseName, and merge queue fields are accepted and ignored. - Manually finalized parallel builds (
parallelTotal: -1) are refused: pass the real total. - No Argos GitHub bot behavior comes with the SDK: link the repository to CirCI's own GitHub App instead (GitHub).
Moving the history
Section titled “Moving the history”Existing Argos builds aren't imported. The first build on your default branch after switching becomes the baseline once someone approves it (a first build is never approved automatically). After that, auto-approve on the default branch (on by default) keeps the baseline moving without review.
Endpoints
Section titled “Endpoints”Under /v2, with Authorization: Bearer circi_…: GET /project, POST /baseline, POST /builds, PUT /builds/:id. The upload target POST /uploads/:buildId/:sha256 (multipart) takes no token: it accepts a file only under its own SHA-256 hash. See the HTTP API overview.