Skip to content

Update retry docs in README #612

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

Merged
alb-rl merged 1 commit into from
Jul 9, 2025
Merged

Update retry docs in README #612

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
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,8 @@ Error codes are as follows:

Certain errors are automatically retried 5 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors are all retried by default.
429 Rate Limit, and >=500 Internal errors are all retried by default for GET requests. For POST requests, only
429 errors will be retried.

You can use the `max_retries` option to configure or disable retry settings:

Expand All @@ -256,12 +257,12 @@ from runloop_api_client import Runloop

# Configure the default for all requests:
client = Runloop(
# default is 2
# default is 5
max_retries=0,
)

# Or, configure per-request:
client.with_options(max_retries=5).devboxes.create()
client.with_options(max_retries=10).devboxes.create()
```

### Timeouts
Expand Down
Loading