Skip to content

adjusted info about rate limit response and retry #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
guthrie-vast wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adjusted info about rate limit response and retry #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions api-reference/rate-limits-and-errors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,24 @@ Some omit `error` and return only `msg` or `message`.

### How rate limits are applied

Vast.ai applies rate limits **per endpoint** and **per identity**. This is enforced as a minimum interval between requests for a given endpoint and identity.
Vast.ai applies rate limits per endpoint and per identity.

The identity is determined by: bearer token + session user + `api_key` query param + client IP.
Unlike other services, this is enforced as a **minimum interval between requests** for a given endpoint and identity, and enforcement is not a binary wall, but determined probabalistically.

Some endpoints also use **method-specific** limits (GET vs POST) and/or **max-calls-per-period** limits for short bursts.
The identity is determined by: bearer token + session user + `api_key` query param and falls back to client IP.


### Rate limit response behavior

When you hit a rate limit, you will receive **HTTP 429**. The response body is often plain text (in certain cases JSON with `success`/`error`/`msg` like above) with one of the following messages:
### Rate limit response and recommended retry behavior

```
API requests too frequent
```

or
When you hit a rate limit, you will receive **HTTP 429**. The response body will typically return an acceptable threshold number in seconds:

```
API requests too frequent: endpoint threshold=...
```

The API does not currently set standard rate-limit headers (for example `Retry-After`), so clients should apply their own backoff strategy.
We recommend you retry your call after the recommended threshold.


### How to reduce rate limit errors

Expand Down