Skip to main content

Documentation

Home Getting Started User Guides API Reference Image Processing Integration Guides Best Practices Resources Support AI Integration Playground URL Builder

API Endpoint Map

On This Page

VIUCraft splits its URLs by base path. Knowing the split tells you, at a glance, which host and prefix any operation lives under.

Rule of thumb: upload and delivery live at the root; everything else (management, CRUD, discovery) lives under /api/.

All paths below are relative to your tenant host, https:// (free tier: https://viucraft.com/free/acc_ for delivery). See Tenancy & URL Bases.

Root — upload & delivery

PurposeMethod + path
UploadPOST /upload (alias: POST /api/upload)
Deliver / transformGET /
Deliver originalGET /

These are the high-traffic, public-facing paths. Delivery is a plain GET of an image URL — see Delivery & Transform URL Grammar.

/api/ — image & account management

PurposeMethod + path
List imagesGET /api/images
Image metadataGET /api/images/
Update (move) imagePATCH /api/images/
Delete imageDELETE /api/images/204
Bulk uploadPOST /api/upload/bulk
Export images (zip)POST /api/images/export
FoldersGET /api/folders, POST /api/folders/move
CachePOST /api/cache/purge, POST /api/cache/warm
CapabilitiesGET /api/capabilities
OpenAPI specGET /api/openapi.json, GET /api/openapi.yaml

/api/v1/ — versioned services

PurposeMethod + path
Unified discovery (recommended)GET /api/v1/whoami
Account configGET /api/v1/account
UsageGET /api/v1/usage
Batch jobsPOST /api/v1/jobs, GET /api/v1/jobs/ (+ GET /api/v1/jobs/ SSE)
WebhooksPOST /api/webhooks, GET/DELETE /api/webhooks/, POST /api/webhooks/
PresetsGET/POST /api/v1/presets, GET/DELETE /api/v1/presets/

/api/v1/cli/ — CLI client endpoints

PurposeMethod + path
Validate keyPOST /api/v1/cli/auth
Identity + usageGET /api/v1/cli/whoami
CLI image opsGET/POST /api/v1/cli/images...

/mcp — agent (Model Context Protocol)

PurposeMethod + path
MCP server (agents)POST /mcp — authenticated with Authorization: Bearer vc_live_...

Note the auth difference: REST endpoints use the X-API-Key header; the MCP endpoint uses Authorization: Bearer.

Discovery first

If you only have an API key, start with GET /api/v1/whoami — it returns your identity, URL bases, usage, and full capabilities in one call, so you can bootstrap without hard-coding anything. The complete request/response contract for every endpoint above is in the OpenAPI spec.

Was this helpful?

On This Page