---
title: "Upload and create snapshot entry"
method: POST
path: "/builds/upload/snapshot"
---

# Upload and create snapshot entry

`POST /builds/upload/snapshot`

## Request

- The document declares no server URL.
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/basset/apis/basset-build-api/docs/builds/upload/snapshot/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-BUILD-ID` string, uuid, required
- `X-RELATIVE-PATH` string, required
- `X-SHA` string, required

## Request body `multipart/form-data`

- object
  - `snapshot` string, binary
  - `widths` string: Single or Multiple (comma separated) width(s)
  - `title` string: Title of the snapshot
  - `selectors` string: CSS selectors used to take a snapshot of elements
  - `hideSelectors` string: CSS selectors used to hide elements
  - `browsers` string: Browser(s) to render snapshots on (comma separated) firefox or chrome

## Response `200`

Uploaded object

- object
  - `uploaded` boolean: Whether the snapshot was uploaded

## Other responses

- `403`: Error

## Changes

- **2026-07-17** `e07c379e33f3`: 1 info
  - api operation id `uploadSnapshot` was added
- **2019-10-30** `dcdba050c4b8`: 1 info
  - api operation id `uploadSnapshot` removed and replaced with ``

[Operation history](https://skmtc.dev/basset/apis/basset-build-api/changes/builds/upload/snapshot/post.md)

---

[API](https://skmtc.dev/basset/apis/basset-build-api.md) - [All operations](https://skmtc.dev/basset/apis/basset-build-api/llms.txt) - [OpenAPI document](https://skmtc.dev/basset/apis/basset-build-api/revisions/e07c379e33f3?raw)