Public API
The ZeroWidth public API lets your code call workspace resources directly. This section is the cross-cutting reference — auth, errors, limits, and the conventions every endpoint follows. Per-tool endpoint details live in each tool's API reference. New here? Make your first API call.
Base URL
https://api.zerowidth.ai/1.0
Every endpoint returns JSON. Authenticated requests carry a bearer token; the public flow gallery is the one anonymous surface.
Credentials
Bearer-token format, key segments, request shape.
ReferenceAPI keysWorkspace service-account keys — mint, scope, budget, revoke.
ReferencePersonal access tokensUser-identity tokens for the CLI and MCP — they act as you.
Conventions
These hold across every endpoint — read them once.
The shared envelope and the machine-readable codes you switch on.
ReferenceLimitsCost caps, spend caps, and request rate limits.
ReferencePaginationThe cursor envelope every list endpoint follows.
ReferenceIdempotencyRetry a write safely with an Idempotency-Key.
Stream a flow run as server-sent events.
ReferenceVersioningWhat /1.0 guarantees and how breaking changes land.
Tool references
Per-tool endpoint reference lives next to its tool:
Run Workbench flows from your code. POST /1.0/flows/:flowUuid/runs.
No REST API — read and build the Compass knowledge graph via the MCP server.