Developer guide
Build on CloudRaker — authenticate, process documents, and automate your workflows over the API.
CloudRaker exposes its whole platform through a single REST API served by a thin gateway at https://api.cloudraker.com. The gateway authenticates your request, resolves your tenant, authorizes the action, and dispatches to the domain services behind it. You get one base URL, one auth header, and JSON everywhere.
One key, one org. A CloudRaker organization API key is a machine credential scoped to a single organization (tenant). Create one under Admin → API keys, send it as a bearer token, and every call runs against that org’s data. See Authentication.
What you can build
Send a document and a JSON Schema, get data shaped like your schema back — with a page-and-region citation behind every field.
Clean markdown and structured JSON out of PDFs, scans, office files, and audio. No schema required.
Strip personal information out of a document or a recording, fill a form from your sources, and collect e-signatures with a sealed audit trail.
Run several capabilities over one file set in a single call — every file parsed once, one run id, one result to poll.
Start a multi-step agent on a set of files, then answer its sign-offs and human steps over the API.
Register a document by URL or presigned upload, then reuse it across runs — parse once, run many.
React to run events as they happen. Every delivery is a public-key-signed JWT you verify against a published JWKS — no shared secret to store.
One lifecycle for every capability: statuses, outputs, TTL, and keep — the bridge from a headless result into the product.
Typed clients for TypeScript and Python that wire up the base URL and bearer token for you.
The earlier multipart pipeline, frozen and still supported. New integrations should use pipelines.
Point Claude and other MCP clients at the CloudRaker MCP server to drive the whole API through Code Mode.
Writing the integration with a coding agent? Hand it one URL — docs.cloudraker.com/developers/agents.md — and it has the whole contract.
At least 67 requests per minute per organization across all of /v1, the 429 envelope, and how to back off.
Every endpoint — spaces, files, actions, runs, playbooks, objects, ontology, search, and more.
Base URLs
The API runs in three fully isolated environments — a key made in one does not work in another. Unless you were given access to staging or development, use production.
Production is also reachable at https://app.cloudraker.com/api for same-origin browser calls. See Environments for the details.
How the gateway works
- Authentication — every request carries
Authorization: Bearer <token>. The gateway accepts a organization API key (the developer story) or a session JWT. See Authentication. - Tenant scoping — your token’s organization is your tenant. You never pass a tenant id; the gateway resolves it and scopes every call automatically.
- Authorization — the gateway decides what a caller may do before it dispatches. Org keys satisfy admin and org-level gates; some per-user resource permissions are only satisfiable by a human’s session token.
- Errors — failures come back as JSON
{ "error": "<snake_case_code>" }with a matching HTTP status; the capability endpoints use a richer{ code, message, retryable, requestId, docUrl }envelope. See Errors. - Rate limits — the
/v1API guarantees at least 67 requests per minute per organization, shared across every endpoint; over it you get429with aRetry-Afterheader. See Rate limits.