Skip to content

docs: clarify async client cleanup #2388

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
marcuswood-oai merged 3 commits into from
Sep 15, 2026
Merged

docs: clarify async client cleanup #2388

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cd9dc8
Add info on garbage collection of async clients
damccorm May 30, 2025
74eae1e
Merge commit '1493321affb1814fba7b669892e376a119d8d36f' into codex/pr…
marcuswood-oai Sep 15, 2026
709862d
docs: clarify async client cleanup
marcuswood-oai Sep 15, 2026
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1072,6 +1072,25 @@ with OpenAI() as client:
# HTTP client is now closed
```

For `AsyncOpenAI`, use `async with` or `await client.close()` before shutting down
the event loop. Garbage collection cannot reliably await asynchronous cleanup.

```py
import asyncio
from openai import AsyncOpenAI


async def main() -> None:
async with AsyncOpenAI() as client:
response = await client.responses.create(
model="gpt-5.5", input="Say this is a test"
)
print(response.output_text)


asyncio.run(main())
```

## Microsoft Azure OpenAI

To use this library with [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview), use the `AzureOpenAI`
Expand Down
Loading