API v2
One API host per organization. One Job object for sync calls, async calls, streams and webhooks.
API v2 is the CloudRaker API for documents and agents. Each organization has its own API host. /v1 on api.cloudraker.com continues without changes.
API v2 is in beta.
The API host
{slug} is the slug of your organization. The slug never changes. Dash shows it in Settings. Each crk_ key contains it.
How it works
- Every call creates a job.
200and202return the same Job object. - The client selects the delivery. Read the result in the answer, in a stream or in a webhook. The headers select the mode, not the route.
- A slow call does not fail. When the wait ends, the job continues and the answer is
202. Read Sync and async. - Credentials stay in your organization. You create API keys and OIDC trusts in Dash.
- A failed job costs nothing. The job records its use in paperwork credits when it ends.
Capabilities
Each capability has one route and one scope. The scope name is the capability name.
A POST body is JSON, with a maximum size of 1 MiB. Send a large file by URL. A capability that reads a file takes { "url": "https://…" } or { "id": "…" }. The id is a file that you registered with POST /v1/files.
The agents capability refuses test keys with 403 test_key_not_allowed, because Run has no test mode.
Other routes
Next steps
- Parse a file: Quickstart.
- Pick a credential: Authentication.
- Understand the job: Jobs.
- Use TypeScript: SDK.