Developer guide
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, and authorizes the action. It then 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. Every call then 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, with a page-and-region citation behind every field.
Get clean markdown and structured JSON out of PDFs, scans, office files, and audio. No schema is required.
Remove personal information from a document or a recording. Fill a form from your sources. Collect e-signatures with a sealed audit trail.
Render a saved template with your own JSON data and get a PDF back. One call produces one document or a batch.
Run several capabilities over one file set in a single call. Every file parses once. You get one run id and 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 is stored.
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. They wire up the base URL and bearer token for you.
The earlier multipart pipeline, frozen and still supported. New integrations must use pipelines.
Point Claude and other MCP clients at the CloudRaker MCP server. Drive the whole API through Code Mode.
Write the integration with a coding agent. Give 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 URL
Every call goes to one base URL:
That is the gateway. It is the only base URL to build against. CloudRaker runs internal environments for its own development. They are not available to API users. Production is your environment.
How the gateway works
- Authentication — every request carries
Authorization: Bearer <token>. The gateway accepts an organization API key (the developer path) 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. Only a human’s session token satisfies some per-user resource permissions.
- 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. Above that, you get429with aRetry-Afterheader. See Rate limits.