Quickstart

Get your first image hosted in 30 seconds. No signup form, no dashboard — just API calls.

1. Register an account

Terminal

curl -X POST https://api.pixelvault.dev/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"your-secure-password"}'

Response:

JSON

{
  "account": { "id": "acct_abc123", "email": "you@example.com" },
  "project": { "id": "proj_xyz789", "name": "Default" },
  "apiKey": "pv_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Save your API key — it's shown only once.

2. Upload an image

Terminal

curl -X POST https://api.pixelvault.dev/v1/images \
  -H "Authorization: Bearer pv_live_xxxxxxxx" \
  -F "file=@screenshot.png"

Response:

JSON

{
  "id": "img_abc123",
  "url": "https://img.pixelvault.dev/proj_xyz789/img_abc123.png",
  "mime_type": "image/png",
  "size_bytes": 245000,
  "width": 1200,
  "height": 800
}

3. Use the URL

The CDN URL is live immediately. Use it in markdown, HTML, or anywhere you need an image.

![Screenshot](https://img.pixelvault.dev/proj_xyz789/img_abc123.png)

Authentication

All API requests (except registration) require a Bearer token:

Authorization: Bearer pv_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API keys use the prefix pv_live_ for production and pv_test_ for test environments. Keys are hashed server-side — we never store the raw key.

API Reference

Base URL: https://api.pixelvault.dev

All responses are JSON. Errors follow the format:

Error response

{
  "error": "error_code",
  "message": "Human-readable description"
}

POST /v1/auth/register

Create a new account. Returns an account, a default project, and an API key.

Field	Type	Required
email	string	Yes
password	string (8+ chars)	Yes

POST /v1/images

Upload an image. Accepts multipart/form-data.

Field	Type	Required
file	binary	Yes
folder	string	No

Supported formats: JPEG, PNG, GIF, WebP, AVIF, SVG.

GET /v1/images

List images in your project. Paginated.

Param	Type	Default
limit	integer	50
offset	integer	0

GET /v1/images/:id

Get a single image's metadata by ID.

DELETE /v1/images/:id

Delete an image. Removes from storage and CDN.

Claude Code skill

PixelVault ships a Claude Code skill for native integration. Install it and your agent can upload images directly.

# Coming soon
claude skill install @pixelvault/upload

Agent discovery

PixelVault provides standard discovery endpoints for any AI agent:

/.well-known/api-catalog — API catalog for agent discovery
/llms.txt — LLM-readable service description
/openapi.json — OpenAPI 3.1 specification