release: 5.0.0

[stainless-app]

Automated Release PR

5.0.0 (2025-05-29)

Full Changelog: v5.0.0-alpha.0...v5.0.0

Features

• add audio helpers (ec5067d)
• add migration guide (cfd2088)
• add SKIP_BREW env var to ./scripts/bootstrap (7ea4a24)
• api: add /v1/responses and built-in tools (91af47c)
• api: add /v1/responses and built-in tools (0612242)
• api: add get /chat/completions endpoint (9697139)
• api: add get /chat/completions endpoint (16c67be)
• api: add get /responses/{response_id}/input_items endpoint (f2c5aba)
• api: add get /responses/{response_id}/input_items endpoint (3676d34)
• api: add container endpoint (3ffca5c)
• api: add container endpoint (e973476)
• api: Add evalapi to sdk (70092d7)
• api: Add evalapi to sdk (#1456) (33b66f5)
• api: add gpt-4.5-preview (1d4478d)
• api: add gpt-4.5-preview (#1349) (bb269a1)
• api: add image sizes, reasoning encryption (0c25021)
• api: add image sizes, reasoning encryption (31cd88f)
• api: add o3 and o4-mini model IDs (19cda5d)
• api: add o3 and o4-mini model IDs (a0d0000)
• api: Add reinforcement fine-tuning api support (e6bbaf5)
• api: Add reinforcement fine-tuning api support (fabe6ec)
• api: add support for storing chat completions (59da177)
• api: add support for storing chat completions (#1327) (be1ca6b)
• api: adding gpt-4.1 family of model IDs (8a2a745)
• api: adding gpt-4.1 family of model IDs (840e7de)
• api: adding new image model support (a0010fd)
• api: adding new image model support (c353531)
• api: Config update for pakrym-stream-param (71c3d31)
• api: Config update for pakrym-stream-param (b4d1b46)
• api: Config update for pakrym-stream-param (469ad7b)
• api: further updates for evals API (3019a7e)
• api: further updates for evals API (3f6f248)
• api: manual updates (debe529)
• api: manual updates (e83286b)
• api: manual updates (959eace)
• api: manual updates (179a607)
• api: manual updates (0cb0c86)
• api: manual updates (678ae6b)
• api: manual updates (4560dc6)
• api: manual updates (554c3b1)
• api: manual updates (b893d81)
• api: manual updates (c1c2819)
• api: manual updates (efce6d3)
• api: manual updates (32afb00)
• api: new API tools (0cc8994)
• api: new API tools (fb4014f)
• api: new models for TTS, STT, + new audio features for Realtime (1eab9ed)
• api: new models for TTS, STT, + new audio features for Realtime (#1407) (d11b13c)
• api: new streaming helpers for background responses (c071491)
• api: new streaming helpers for background responses (1ddd6ff)
• api: o1-pro now available through the API (3540b06)
• api: o1-pro now available through the API (#1398) (aefd267)
• api: responses x eval api (b349ade)
• api: responses x eval api (ea1d56c)
• api: Updating Assistants and Evals API schemas (e68f598)
• api: Updating Assistants and Evals API schemas (8cc63d3)
• client: accept RFC6838 JSON content types (67da9ce)
• client: add Realtime API support (7737d25)
• client: add withOptions helper (7e9ea85)
• client: improve logging (ead0ba4)
• client: promote beta completions methods to GA (4c622f9)
• version 5 (855144b)
• version 5 (855144b)

Bug Fixes

• api: add missing file rank enum + more metadata (b943a0a)
• api: correct some Responses types (3ca8965)
• api: correct some Responses types (#1391) (e983d0c)
• api: improve type resolution when importing as a package (b6bf469)
• api: improve type resolution when importing as a package (#1444) (4af79dd)
• assistants: handle thread.run.incomplete event (a2714bb)
• audio: correctly handle transcription streaming (9c7d352)
• avoid type error in certain environments (#1413) (f395e95)
• azure/audio: use model param for deployments (0eda70a)
• azure: add /images/edits to deployments endpoints (#1509) (4b18059)
• azure: add /images/edits to deployments endpoints (#1509) (84fc31a)
• azure: use correct internal method (a9c7821)
• client: always overwrite when merging headers (c160550)
• client: fix export map for index exports (#1328) (26d5868)
• client: fix export map for index exports, accept BunFile (9416c96)
• client: fix TypeError with undefined File (0e980d0)
• client: remove duplicate types (bee2ce5)
• client: remove duplicate types (#1410) (23fd3ff)
• client: return binary content from get /containers/{container_id}/files/{file_id}/content (8502966)
• client: return binary content from get /containers/{container_id}/files/{file_id}/content (899869b)
• client: return binary content from get /containers/{container_id}/files/{file_id}/content (83129d7)
• client: send X-Stainless-Timeout in seconds (5a272a7)
• client: send X-Stainless-Timeout in seconds (#1442) (5e5e460)
• client: send all configured auth headers (ee01414)
• compat with more runtimes (f743730)
• correct imports (21f2107)
• correctly decode multi-byte characters over multiple chunks (f3d7083)
• docs: correct docstring on responses.stream (1847673)
• ecosystem-tests/bun: bump dependencies (1e52734)
• ecosystem-tests/cloudflare-worker: ignore lib errors for now (157248a)
• ecosystem-tests: correct ecosystem tests setup (6fa0675)
• embeddings: correctly decode base64 data (#1448) (d6b99c8)
• exports: add missing type exports (a816029)
• exports: add missing type exports (#1417) (06c03d7)
• exports: ensure resource imports don't require /index (d028ad7)
• helpers/zod: error on optional + not nullable fields (6e424b5)
• internal: add mts file + crypto shim types (a06deb8)
• internal: clean up undefined File test (da43aa9)
• internal: fix file uploads in node 18 jest (abfff03)
• internal: work around turbopack removes side effects, breaking module initialization. vercel/next.js#76881 (#1427) (84edc62)
• jsr: correct zod config (04e30c0)
• jsr: export realtime helpers (0ea64eb)
• jsr: export zod helpers (77e1180)
• mcp: remove unused tools.ts (752f4f1)
• mcp: remove unused tools.ts (#1445) (4ba9947)
• optimize sse chunk reading off-by-one error (a7effe8)
• optimize sse chunk reading off-by-one error (#1339) (b0b4189)
• package: add chat/completions.ts back in (#1333) (ee34833)
• package: add chat/completions.ts back in (#1333) (1f38cc1)
• parsing: remove tool_calls default empty array (#1341) (40e8dd2)
• parsing: remove tool_calls default empty array (#1341) (6d056bf)
• realtime: call .toString() on WebSocket url (#1324) (6e9444c)
• responses: correct computer use enum value (66fb815)
• responses: correct reasoning output type (1698b95)
• responses: correct reasoning output type (9cb9576)
• responses: correctly add output_text (8ae07cc)
• responses: support streaming retrieve calls (657807c)
• tests/embeddings: avoid cross-realm issue (aceaac0)
• tests: don't rely on OPENAI_API_KEY env variable (087580a)
• tests: manually reset node:buffer File (1d18ed4)
• tests: port tests to new setup (9eb9854)
• tests: stop using node:stream (317a04d)
• threads: remove unused duplicative types (0b77c7c)
• types: export AssistantStream (#1472) (bc492ba)
• types: export ParseableToolsParams (#1486) (3e7c92c)
• types: ignore missing id in responses pagination (d2be74a)
• types: improve responses type names (96ed4db)
• types: improve responses type names (#1392) (4548326)
• zod: warn on optional field usage (#1469) (aea2d12)

Performance Improvements

• embedding: default embedding creation to base64 (#1312) (be00d29), closes #1310

Chores

• add hash of OpenAPI spec/config inputs to .stats.yml (1b0a94d)
• add hash of OpenAPI spec/config inputs to .stats.yml (48921aa)
• add missing type alias exports (5d75cb9)
• add missing type alias exports (#1390) (f4647cc)
• api: updates to supported Voice IDs (28130c7)
• api: updates to supported Voice IDs (#1424) (fb0e96a)
• ci: add timeout thresholds for CI jobs (5775451)
• ci: add timeout thresholds for CI jobs (939f636)
• ci: bump node version for release workflows (bbf5d45)
• ci: only use depot for staging repos (c59c3b5)
• ci: only use depot for staging repos (214da39)
• ci: run on more branches and use depot runners (e17a4f8)
• ci: run on more branches and use depot runners (ead76fc)
• client: drop support for EOL node versions (a326944)
• client: expose headers on some streaming errors (#1423) (6c93a23)
• client: minor internal fixes (5032c28)
• client: minor internal fixes (6558b7c)
• client: more accurate streaming errors (0c21914)
• client: move misc public files to new core/ directory, deprecate old paths (38c9d54)
• client: only accept standard types for file uploads (53e35c8)
• deprecate Assistants API (0be23b9)
• deprecate Assistants API (1726e6b)
• deprecate Assistants API (5b34fcd)
• docs: add missing deprecation warnings (5495529)
• docs: add missing deprecation warnings (995075b)
• docs: grammar improvements (d5d62b0)
• docs: grammar improvements (7761cfb)
• docs: improve docs for withResponse/asResponse (9f4c30b)
• docs: improve migration doc (732d870)
• docs: update zod tool call example, fix azure tests (f18ced8)
• exports: cleaner resource index imports (0da1c16)
• exports: cleaner resource index imports (#1396) (023d106)
• exports: stop using path fallbacks (09af7ff)
• exports: stop using path fallbacks (#1397) (7c3d212)
• fix example types (20f179d)
• improve publish-npm script --latest tag logic (6d3cc5c)
• improve publish-npm script --latest tag logic (1f59811)
• improve publish-npm script --latest tag logic (6207a2a)
• internal: add aliases for Record and Array (8957ff4)
• internal: add aliases for Record and Array (#1443) (1cb66b6)
• internal: add back release workflow (ca6266e)
• internal: add Bun.File ecosystem test (cb4194f)
• internal: add missing return type annotation (00ce31b)
• internal: add missing return type annotation (#1334) (13aab10)
• internal: add proxy ecosystem tests (619711a)
• internal: bump migration cli version (a899c97)
• internal: codegen related update (fa48353)
• internal: codegen related update (c735a3c)
• internal: fix devcontainers setup (873e273)
• internal: fix devcontainers setup (#1343) (9485f5d)
• internal: fix eslint ignores (ad5a9b6)
• internal: fix examples (db23ff3)
• internal: fix examples (#1457) (a100f0a)
• internal: fix format script (3e1ea40)
• internal: fix formatting (6469d53)
• internal: fix lint (45a372c)
• internal: fix release workflows (0e4b982)
• internal: fix release workflows (353349d)
• internal: fix tests failing on node v18 (c54270a)
• internal: fix tests not always being type checked (0266b41)
• internal: improve node 18 shims (ee3f483)
• internal: minor client file refactoring (d1aa00a)
• internal: only run examples workflow in main repo (#1450) (93569f3)
• internal: reduce CI branch coverage (bb39dba)
• internal: reduce CI branch coverage (77fc77f)
• internal: refactor utils (e7fbfbc)
• internal: remove CI condition (ef43345)
• internal: remove CI condition (#1381) (e905c95)
• internal: remove unnecessary todo (b55321e)
• internal: run CI on update-specs branch (9c45ef3)
• internal: run example files in CI (#1357) (1044c48)
• internal: share typescript helpers (2470933)
• internal: skip broken test (5b81f62)
• internal: skip broken test (#1458) (58f4559)
• internal: update @types/bun (d94b41a)
• internal: update release workflows (2cbf49a)
• internal: upload builds and expand CI branch coverage (3dcbe17)
• internal: upload builds and expand CI branch coverage (#1460) (2d45287)
• internal: version bump (b40e830)
• internal: version bump (5123fe0)
• internal: version bump (#1393) (2e49526)
• migration: add beta handling (3508099)
• move ChatModel type to shared (236dbf4)
• package: remove engines (500a82f)
• perf: faster base64 decoding (11b9534)
• Remove deprecated/unused remote spec feature (00bdda3)
• Remove deprecated/unused remote spec feature (71950f6)
• revert temporary version change (47a8350)
• tests: improve enum examples (0b30331)
• tests: improve enum examples (#1454) (15a86c9)
• tests: stop using node-fetch, don't directly upload FormDataFile (ebd464f)
• tests: switch proxy tests to fetchOptions (da6ed5f)
• types: improved go to definition on fetchOptions (f1712cd)
• update next to 14.2.25 for CVE-2025-29927 (1ed4288)
• workaround build errors (e4a7f67)
• workaround build errors (d6b396b)

Documentation

• add examples to tsdocs (e8d2092)
• fix "procesing" -> "processing" in realtime examples (#1406) (dfbdc65)
• migration: mention function renames (eb773ee)
• migration: mention zod helpers error (43b870d)
• readme: fix typo (c44ed98)
• readme: fix typo (0989ddc)
• update URLs from stainlessapi.com to stainless.com (e4e737d)
• update URLs from stainlessapi.com to stainless.com (#1352) (634a209)

Refactors

• client: remove deprecated runFunctions method (e29a009)
• functions: rename function helper methods to include tools (fdd6f66)

---

This pull request is managed by Stainless's GitHub App.

The semver version number is based on included commit messages. Alternatively, you can manually set the version number in the title of this pull request.

For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.

🔗 Stainless website
📚 Read the docs
🙋 Reach out for help or questions

[stainless-app]

Release version edited manually

The Pull Request version has been manually set to 5.0.0 and will be used for the release.

If you instead want to use the version number 5.0.0-alpha.1 generated from conventional commits, just remove the label autorelease: custom version from this Pull Request.

[stainless-app]

🤖 Release is at https://github.com/openai/openai-node/releases/tag/v5.0.0 🌻