Images Videos Audio Pricing Docs View as Markdown (Agent) Get started
Human Agent

API reference

Projects

Isolate media, API keys, usage, webhooks and idempotency keys inside one account. Free includes 1 project, Starter 3 and Pro 10.

List account projects

GET /v1/projects

Lists every project owned by the account and the plan's project limit. Secret API keys mark their own project as current; dashboard sessions return the same account-level list.

Authentication

API key, or a dashboard session token, sent as Authorization: Bearer <token>.

Responses

Request
curl https://api.pixelvault.dev/v1/projects \
  -H "Authorization: Bearer $PIXELVAULT_API_KEY"
Response 200
{
  "data": [
    {
      "id": "proj_abc123",
      "name": "Production",
      "created_at": "2026-11-17T09:30:00Z",
      "current": true
    }
  ],
  "meta": {
    "limit": 3,
    "total": 2
  }
}

Create a project

POST /v1/projects

Creates an isolated project and its first live secret key. The raw api_key is returned once. A full plan returns 409 project_limit_reached.

Authentication

API key, or a dashboard session token, sent as Authorization: Bearer <token>.

Request body

application/json, required

Request body
Name Type Required Description
name string Required

min length 1 · max length 100

Responses

Request
curl -X POST https://api.pixelvault.dev/v1/projects \
  -H "Authorization: Bearer $PIXELVAULT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
Response 201
{
  "data": {
    "project": {
      "id": "proj_abc123",
      "name": "Production",
      "created_at": "2026-11-17T09:30:00Z"
    },
    "api_key": "pv_live_…",
    "key_id": "key_abc123"
  }
}

Rename a project

PATCH /v1/projects/{id}

Authentication

API key, or a dashboard session token, sent as Authorization: Bearer <token>.

Path parameters

Path parameters
Name Type Required Description
id string Required

Project id (proj_ prefix).

Request body

application/json, required

Request body
Name Type Required Description
name string Required

min length 1 · max length 100

Responses

Request
curl -X PATCH https://api.pixelvault.dev/v1/projects/id \
  -H "Authorization: Bearer $PIXELVAULT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
Response 200

Renamed project

Delete an empty project

DELETE /v1/projects/{id}

Deletes an empty non-final project and revokes its keys and webhooks. Remove media and custom domains first, then wait for multipart uploads or exports to finish. A secret API key cannot delete its own project.

Authentication

API key, or a dashboard session token, sent as Authorization: Bearer <token>.

Path parameters

Path parameters
Name Type Required Description
id string Required

Project id (proj_ prefix).

Responses

Request
curl -X DELETE https://api.pixelvault.dev/v1/projects/id \
  -H "Authorization: Bearer $PIXELVAULT_API_KEY"
Response 200

Deleted project