Images

Start a bulk export

Start an asynchronous export of every image in the project into a downloadable tar archive (plus a manifest.json of id, filename, storage key, URL, and metadata per image). Your data is always portable — no lock-in. Returns a job; poll status_url until complete, then download. Auth is project-scoped: pass a secret key to export that key's project, or a dashboard token together with a project_id query parameter.

post/v1/export

Request

Base URL: https://api.pixelvault.dev
URL: https://api.pixelvault.dev/v1/export
Auth: HTTP bearer

Query parameters

project_idstring

Example:proj_a1b2c3d4e5f6

Required only when authenticating with a dashboard token; ignored for secret-key auth (the key already identifies the project).

Response

Export job accepted. Poll status_url until status is 'complete'.

job_idstring

statusstring

image_countinteger

status_urlstring

Example response

{
  "job_id": "exp_a1b2c3d4e5f6",
  "status": "pending",
  "image_count": 128,
  "status_url": "/v1/export-jobs/exp_a1b2c3d4e5f6"
}

Changes

No recorded changes to this operation across all 1 revision of this API.