Skip to navigation

Rate limits

Token buckets per organization and environment, and a concurrency limit for each class of job.
View as Markdown

API v2 has two kinds of limit. A token bucket counts requests and units per minute. A concurrency limit counts the jobs that run at the same time. The Limits page of Dash shows your tier and the current use.

Tiers

TierWhenRequests per minuteUnits per minuteConcurrent jobs: parse / action / agent / inline
testTest keys. Live keys before the first plan sync.602001 / 1 / 1 / 2
freeFree plans and trials1205001 / 1 / 1 / 4
starterStarter60030005 / 5 / 5 / 10
proPro12001000010 / 10 / 10 / 20
enterpriseEnterprise30003000010 / 10 / 25 / 50

Live and test each have their own buckets and concurrency slots, so a test job never uses a live slot.

Units are the metered amounts of a job, for example pages. They are the values in usage.units.

Test keys always have the test tier limits, but their jobs use real paperwork credits.

A key with a rate cap, or a trust with a requests limit, has its own requests bucket inside the organization limits.

Headers

Every admitted or refused answer has these headers:

HeaderMeaning
x-ratelimit-limit-requestsThe size of the requests bucket per minute.
x-ratelimit-remaining-requestsThe requests left now.
x-ratelimit-reset-requestsThe time to a full bucket, for example 2s or 1m0s.
x-ratelimit-limit-unitsThe size of the units bucket per minute.
x-ratelimit-remaining-unitsThe units left now.
x-ratelimit-reset-unitsThe time to a full bucket.
retry-afterOn a 429: the seconds to wait, 1 or more.

The units headers are absent when the units limit does not apply. A 404 tenant_not_found has no rate-limit headers.

Refusals

StatusCodeCauseAction
429rate_limit_exceededThe requests or units bucket is empty.Wait for the time in retry-after.
429concurrency_limitedThe class of the job has no free slot.Wait for a running job to finish.
402credits_exhaustedThe organization has no credits.Add credits in Dash.

A refused request does not use rate budget. A job in needs_input holds no slot.

A units bucket needs a positive balance to admit a job. The job takes its real units from the bucket when it ends.

Concurrency classes

ClassCapabilities
parseparse, transcribe
actionextract, classify, split, fill, redact, sign
agentagents
inlinegenerate, convert, redline

How the limits work

The buckets live in memory, one per organization and environment. A deploy can refill a bucket. Do not treat a refill as a higher limit.

Your plan sets the tier. To ask for higher limits, contact CloudRaker from the Limits page.