CHANGELOG.md

Changelog

3.0.0-rc1 (2026-04-13)

Full Changelog: v2.4.0...v3.0.0-rc1

Features

• api: Deprecate AI Detection, Medical Comprehend, and Context-Aware Text Splitting (c6bee06)
• client: add custom JSON encoder for extended type support (a855555)
• client: add support for binary request streaming (56bd96e)
• internal: implement indices array format for query and form serialization (898e230)

Bug Fixes

• client: preserve hardcoded query params when merging with user params (70761a4)
• deps: bump minimum typing-extensions version (e8e396e)
• docs: fix mcp installation instructions for remote servers (b448904)
• ensure file data are only sent as 1 parameter (ae4c4ad)
• pydantic: do not pass by_alias unless set (f8a82fe)
• remove custom binary_request handling superseded by codegen (#28) (763afaf)
• resolve duplicate code (#29) (57837bc)
• sanitize endpoint path params (e87c2a0)

Chores

• ci: skip lint on metadata-only changes (e8479c1)
• ci: skip uploading artifacts on stainless-internal branches (f8763df)
• ci: upgrade actions/github-script (aa28320)
• format all api.md files (0d10457)
• internal: add request options to SSE classes (fead372)
• internal: bump dependencies (6d39e6e)
• internal: fix lint error on Python 3.14 (0cf9c5f)
• internal: make test_proxy_environment_variables more resilient (00a019f)
• internal: make test_proxy_environment_variables more resilient to env (2ec43af)
• internal: tweak CI branches (cff7016)
• internal: update actions/checkout version (4de949f)
• internal: update gitignore (c1351cf)
• internal: version bump (6733bea)
• test: do not count install time for mock server timeout (ca18be8)
• tests: bump steady to v0.19.4 (57552b1)
• tests: bump steady to v0.19.5 (ec60cc4)
• tests: bump steady to v0.19.6 (54e2229)
• tests: bump steady to v0.19.7 (9b78194)
• tests: bump steady to v0.20.1 (09fa209)
• tests: bump steady to v0.20.2 (4bb6605)
• update mock server docs (dd5b8a9)
• update placeholder string (3d66005)

Documentation

• api: updates to API spec (832318c)

Refactors

• tests: switch from prism to steady (b63e313)

2.4.0 (2026-02-06)

Full Changelog: v2.4.0-rc1...v2.4.0

Chores

• internal: codegen related update (071f9af)

2.4.0-rc1 (2026-01-12)

Full Changelog: v2.3.3-rc1...v2.4.0-rc1

Features

• api: manual updates (26cd543)
• api: manual updates (f95b625)

Bug Fixes

• types: allow pyright to infer TypedDict types within SequenceNotStr (d1f6535)
• use async_to_httpx_files in patch method (a6fbc3c)

Chores

• add missing docstrings (a3c938c)
• docs: use environment variables for authentication in code snippets (534af15)
• internal: add --fix argument to lint script (4b3b067)
• internal: add missing files argument to base client (9672ca2)
• internal: codegen related update (ddab89d)
• speedup initial import (4ae973c)
• update lockfile (abd7b3d)

Documentation

• prominently feature MCP server setup in root SDK readmes (8ed50d2)

2.3.3-rc1 (2025-12-01)

Full Changelog: v2.3.2...v2.3.3-rc1

Bug Fixes

• client: close streams without requiring full consumption (31e3903)
• compat with Python 3.14 (56db271)
• compat: update signatures of model_dump and model_dump_json for Pydantic v1 (1fb3322)
• ensure streams are always closed (23c7971)

Chores

• bump httpx-aiohttp version to 0.1.9 (f2ef07d)
• deps: mypy 1.18.1 has a regression, pin to 1.17 (74b4799)
• internal/tests: avoid race condition with implicit client cleanup (828ac4d)
• internal: codegen related update (3b5b4a6)
• internal: detect missing future annotations with ruff (9df4451)
• internal: grammar fix (it's -> its) (e8b1113)
• package: drop Python 3.8 support (9b204ce)

Documentation

• api: updates to API spec (04fe076)

2.3.2 (2025-10-03)

Full Changelog: v2.3.2-rc2...v2.3.2

2.3.2-rc2 (2025-10-01)

Full Changelog: v2.3.2-rc1...v2.3.2-rc2

Features

• api: manual updates (4fb84e2)
• api: manual updates (d7b4637)

Chores

• do not install brew dependencies in ./scripts/bootstrap by default (7912ae2)
• internal: update pydantic dependency (c2f8537)
• types: change optional parameter type from NotGiven to Omit (702d003)
• update more locations to use Omit (5f1a99c)

Documentation

• api: updates to API spec (7e349a9)

2.3.2-rc1 (2025-09-11)

Full Changelog: v2.3.1...v2.3.2-rc1

Features

• improve future compat with pydantic v3 (74315c4)
• types: replace List[str] with SequenceNotStr in params (2c1a7de)

Bug Fixes

• avoid newer type syntax (4aec590)
• client: custom patch to prepare pydantic v3 (8a26e46)

Chores

• client: format (fa024a5)
• client: update stop params in stream/parse to match chat (8920408)
• internal: add Sequence related utils (40901e2)
• internal: change ci workflow machines (84dcbed)
• internal: move mypy configurations to pyproject.toml file (2518950)
• internal: update pyright exclude list (815b794)
• tests: simplify get_platform test (f1ddbb2)
• update github action (d81d1ec)

Documentation

• api: updates to API spec (daf31d5)
• api: updates to API spec (5f8a109)

2.3.1 (2025-08-20)

Full Changelog: v2.3.1-rc1...v2.3.1

2.3.1-rc1 (2025-08-19)

Full Changelog: v2.3.0...v2.3.1-rc1

Documentation

• api: updates to API spec (8f5acc8)

2.3.0 (2025-08-14)

Full Changelog: v2.3.0-rc1...v2.3.0

2.3.0-rc1 (2025-08-12)

Full Changelog: v2.2.1...v2.3.0-rc1

Features

• api: add web KG and web search (127319b)
• client: support file upload requests (aa0d06d)

Bug Fixes

• Add web_search_data to streaming tests. (73f3db7)
• parsing: ignore empty metadata (8874173)
• parsing: parse extra field types (d1f5948)

Chores

• internal: fix ruff target version (851522b)
• internal: update comment in script (279d7df)
• project: add settings file for vscode (1c5e20c)
• update @stainless-api/prism-cli to v5.15.0 (cdbd4b3)

Documentation

• api: updates to API spec (4482f85)
• api: updates to API spec (fe26f83)
• api: updates to API spec (a780648)

2.2.1 (2025-07-16)

Full Changelog: v2.2.0...v2.2.1

Features

• clean up environment call outs (fc436af)
• client: add follow_redirects request option (1bf8218)
• client: add support for aiohttp (843d69d)

Bug Fixes

• allow utf-8 encoded filename in headers (27ebc83)
• ci: correct conditional (7f49d8d)
• ci: release-doctor — report correct token name (0d20a9e)
• client: correctly parse binary response | stream (55872c2)
• client: don't send Content-Type header on GET requests (ffcc579)
• merged_headers -> default_headers to avoid conflicts (6b7aeb4)
• package: support direct resource imports (2016cda)
• parsing: correctly handle nested discriminated unions (a4774a8)
• tests: fix: tests which call HTTP endpoints directly with the example parameters (f5db115)

Chores

• ci: change upload type (9ee05fb)
• ci: enable for pull requests (2dc262b)
• ci: fix installation instructions (b421fd0)
• ci: only run for pushes and fork pull requests (ced5ec3)
• ci: upload sdks to package manager (bfc448f)
• docs: grammar improvements (302e1a8)
• docs: remove reference to rye shell (b6a9aff)
• docs: remove unnecessary param examples (b78bf04)
• internal: avoid errors for isinstance checks on proxies (6bec701)
• internal: avoid lint errors in pagination expressions (abf0203)
• internal: bump pinned h11 dep (383abab)
• internal: codegen related update (81c98bd)
• internal: update conftest.py (f6aa1eb)
• package: mark python 3.13 as supported (fe9f5d9)
• parse environment variables for default headers (fd7c358)
• readme: fix version rendering on pypi (b93bb29)
• readme: update badges (52ec704)
• tests: add tests for httpx client instantiation & proxies (5e99c8f)
• tests: run tests in parallel (6c8b5ad)
• tests: skip some failing tests on the latest python versions (94bb5d6)

Documentation

• api: updates to API spec (4902642)
• api: updates to API spec (e704323)
• client: fix httpx.Timeout documentation reference (f0cc6ef)

2.2.0 (2025-04-30)

Full Changelog: v2.2.0-rc1...v2.2.0

Documentation

• api: updates to API spec (0236e86)
• README updates (c85f8b5)
• Update models in README. (da7e11a)

2.2.0-rc1 (2025-04-25)

Full Changelog: v2.1.0...v2.2.0-rc1

Features

• api: add ai detect tool endpoint (5155d78)
• api: add translation endpoint (c475528)
• chat: add parse method (#237) (81aae52)

Bug Fixes

• perf: optimize some hot paths (b1304d3)
• perf: skip traversing types for NotGiven values (db0383a)
• pydantic v1: more robust ModelField.annotation check (fe810b2)

Chores

• broadly detect json family of content-type headers (128b22a)
• ci: add timeout thresholds for CI jobs (7e48fde)
• ci: only use depot for staging repos (4e41929)
• ci: run on more branches and use depot runners (00cad5e)
• client: minor internal fixes (8f42cd8)
• internal: base client updates (77cdb4a)
• internal: bump pyright version (bcd957a)
• internal: expand CI branch coverage (#235) (672e10d)
• internal: fix list file params (d8f9820)
• internal: import reformatting (3994040)
• internal: minor formatting changes (2064f80)
• internal: reduce CI branch coverage (725029b)
• internal: refactor retries to not use recursion (acf730e)
• internal: slight transform perf improvement (#233) (92b7914)
• internal: update models test (ba97e8f)
• internal: update pyright settings (8f7e894)

Documentation

• api: updates to API spec (fa87048)
• api: updates to API spec (7606fe4)
• api: updates to API spec (a423a7e)
• api: updates to API spec (91598ac)
• swap examples used in readme (#231) (e944c5b)

2.1.0 (2025-04-04)

Full Changelog: v2.1.0-rc1...v2.1.0

Chores

• internal: remove trailing character (#227) (f8ad509)
• internal: version bump (#225) (7df4049)

2.1.0-rc1 (2025-04-01)

Full Changelog: v2.0.0...v2.1.0-rc1

Features

• add chat streaming helpers (#209) (7b65fc1)
• api: Add Vision endpoint. (#220) (886b828)
• api: Add Vision endpoint. (#221) (967073d)

Bug Fixes

• ci: ensure pip is always available (#214) (7285bc1)
• ci: remove publishing patch (#215) (26c3993)
• types: handle more discriminated union shapes (#213) (d1a067c)

Chores

• docs: update client docstring (#203) (3779210)
• fix typos (#222) (2ad9218)
• internal: bump rye to 0.44.0 (#211) (7efe8a4)
• internal: codegen related update (#204) (f5e9ce7)
• internal: Fix README code samples. (#219) (2efd5ea)
• internal: Fix README samples. (#217) (a06f969)
• internal: remove extra empty newlines (#210) (3b5fd4c)
• internal: version bump (#200) (a7b5f67)

Documentation

• api: updates to API spec (#208) (829e77a)
• api: updates to API spec (#216) (3d29c55)
• api: updates to API spec (#223) (c72a478)
• api: updates to API spec (#224) (7a990d7)
• revise readme docs about nested params (#206) (ce4dfcc)
• update URLs from stainlessapi.com to stainless.com (#202) (5895a7a)

2.0.0 (2025-02-26)

Full Changelog: v2.0.0-rc1...v2.0.0

Chores

• internal: properly set pydantic_private (#197) (533c0f8)
• internal: version bump (#194) (f75756f)

Documentation

• Add file upload examples to README. (#199) (628cf7f)
• api: updates to API spec (#196) (2867dbb)

2.0.0-rc1 (2025-02-21)

Full Changelog: v1.6.1...v2.0.0-rc1

⚠ BREAKING CHANGES

• api: define chat completion models (#157)

Features

• api: add async jobs and graph association (#167) (5ffd871)
• api: add list and retrieve applications (#176) (79e2193)
• api: add types for application jobs (#171) (e73ec53)
• api: define chat completion models (#157) (2a1d32a)
• api: update application jobs pagination response (#169) (cb30cef)
• client: allow passing NotGiven for body (#187) (b179ebb)
• client: send X-Stainless-Read-Timeout header (#175) (2f6ceb9)

Bug Fixes

• api: fix offset pagination schema (#177) (fca1562)
• asyncify on non-asyncio runtimes (#183) (b8d96bb)
• client: mark some request bodies as optional (b179ebb)
• client: only call .close() when needed (#152) (c999f9a)
• correctly handle deserialising cls fields (#158) (b05ec58)
• tests: make test_get_platform less flaky (#163) (04a7500)

Chores

• add missing isclass check (#149) (ceb0f57)
• api: fixes to ApplicationJobs pagination (#172) (65f35f9)
• internal: avoid pytest-asyncio deprecation warning (#164) (b31f771)
• internal: bummp ruff dependency (#174) (6f21ba2)
• internal: bump httpx dependency (#151) (2bb3be6)
• internal: bump pyright dependency (#161) (062f2b0)
• internal: change default timeout to an int (#173) (74ed0c0)
• internal: codegen related update (#147) (9f6686e)
• internal: codegen related update (#154) (3bb05ac)
• internal: codegen related update (#179) (938a558)
• internal: codegen related update (#186) (6c0e449)
• internal: fix devcontainers setup (#188) (41c98aa)
• internal: fix type traversing dictionary params (#178) (2349440)
• internal: minor formatting changes (#166) (b4dd853)
• internal: minor style changes (#165) (617eb51)
• internal: minor type handling changes (#180) (f625d90)
• internal: update client tests (#182) (16197d5)
• internal: update deps (#159) (56aa67e)
• test: update some test values (#184) (aafd471)

Documentation

• api: updates to API spec (#160) (04aa2d8)
• api: updates to API spec (#168) (66b6319)
• api: updates to API spec (#170) (49e58c8)
• api: updates to API spec (#181) (0274de8)
• api: updates to API spec (#185) (dddde9f)
• Fix README code samples. (#193) (ec22477)
• fix typos (#153) (5b80591)
• raw responses: fix duplicate the (#162) (8de8d84)
• README code sample updates (#189) (1a3af86)
• Update README. (#192) (6fc78a9)

1.6.1 (2024-12-17)

Full Changelog: v1.6.0...v1.6.1

Chores

• internal: codegen related update (#140) (ac0d81e)
• internal: fix some typos (#145) (cb1be53)

1.6.0 (2024-12-16)

Full Changelog: v1.5.0...v1.6.0

Features

• api: add streaming to application generation (#132) (c142caa)
• api: api update (#131) (efadeb6)

Chores

• internal: add support for TypeAliasType (#137) (4523c9d)
• internal: bump pydantic dependency (#134) (eb1ebfe)
• internal: bump pyright (#129) (f1b2b64)
• internal: bump pyright (#136) (66af392)
• internal: updated imports (#138) (fc58a7d)
• make the Omit type public (#133) (94b63bb)

Documentation

• readme: example snippet for client context manager (#139) (30ae872)
• readme: fix http client proxies example (#135) (4e39cfe)

1.5.0 (2024-11-28)

Full Changelog: v1.4.0...v1.5.0

Features

• api: manual updates (#127) (ae6716d)

Bug Fixes

• client: compat with new httpx 0.28.0 release (#126) (4c04e11)

Chores

• fix formatting (c33a293)
• internal: codegen related update (#125) (a72d9d9)
• internal: fix compat model_dump method when warnings are passed (#121) (51a4ae5)
• remove now unused cached-property dep (#124) (96715e2)

Documentation

• add info log level to readme (#123) (126bf74)

1.4.0 (2024-11-20)

Full Changelog: v1.3.0...v1.4.0

Features

• api: default timeout increase to 3 min (#119) (f263e59)

Chores

• rebuild project due to codegen change (#116) (66d114e)
• rebuild project due to codegen change (#118) (c527530)

1.3.0 (2024-11-12)

Full Changelog: v1.2.0...v1.3.0

Features

• api: add streaming to kg question (#109) (cf85c8a)
• api: api update (#108) (785dd02)
• api: api update (#97) (75f6211)
• api: manual updates (#102) (25d0319)
• api: manual updates (#111) (9f80bb4)
• api: manual updates (#114) (b9fc454)
• api: rename kg question and add text-to-graph (#112) (c4ac9fd)
• api: update tools api methods (#107) (c45ab5b)

Bug Fixes

• fix tool_choice schema (403c875)

Chores

• rebuild project due to codegen change (#100) (fbb3664)
• rebuild project due to codegen change (#101) (1e0cbc1)
• rebuild project due to codegen change (#103) (dcd2402)
• rebuild project due to codegen change (#104) (e9f2e66)
• rebuild project due to codegen change (#105) (4d1c32c)
• rebuild project due to codegen change (#106) (5c27b9e)
• rebuild project due to codegen change (#113) (477b79c)
• rebuild project due to codegen change (#99) (490c02f)

1.2.0 (2024-10-10)

Full Changelog: v1.1.0...v1.2.0

Features

• api: api update (#94) (52fa213)

1.1.0 (2024-10-09)

Full Changelog: v1.0.0...v1.1.0

Features

• api: api update (#91) (afcb68f)

1.0.0 (2024-10-09)

Full Changelog: v0.7.0...v1.0.0

Features

• api: add model graphs.Question (#74) (c058228)
• api: rename to chat_completion_chunk (#81) (e1fa0a5)
• api: update models in readme (#89) (2da514d)

Bug Fixes

• change body to binary request (9a9b656)
• client: avoid OverflowError with very large retry counts (#87) (4363005)
• files upload use binary request (#85) (105e45f)

Chores

• add repr to PageInfo class (#88) (6110292)
• internal: add support for parsing bool response content (#84) (1e8bc07)
• internal: codegen related update (#76) (d62d030)
• internal: codegen related update (#79) (6223c47)
• internal: codegen related update (#80) (f34c186)

Documentation

• add pagination example (#82) (c0c53bf)
• api: updates to API spec (#77) (e3bd1e1)
• api: updates to API spec (#83) (50f4e45)
• api: updates to API spec (#86) (708f32e)

0.7.0 (2024-09-24)

Full Changelog: v0.6.1...v0.7.0

Features

• api: manual updates (#69) (f245fa4)
• api: manual updates (#71) (247eef8)
• client: send retry count header (#68) (8853d08)

Bug Fixes

• client: handle domains with underscores (#67) (73fced9)
• lint: format (9ce59b1)

Chores

• internal: codegen related update (#65) (8ecc8f5)

Documentation

• api: updates to API spec (#64) (a86b730)
• api: updates to API spec (#70) (a87a2d6)

0.6.1 (2024-09-06)

Full Changelog: v0.6.0...v0.6.1

Chores

• internal: codegen related update (#60) (861c8e5)
• pyproject.toml formatting changes (#62) (8839b69)

0.6.0 (2024-08-14)

Full Changelog: v0.5.0...v0.6.0

Features

• api: added method to generate applications content (#47) (36cbfa1)
• api: update via SDK Studio (#41) (99b6f5b)
• api: update via SDK Studio (#45) (c5fdc23)
• api: update via SDK Studio (#46) (fab32ca)
• joint upload_and_add_file_to_graph method for graph resources (f330ec5)

Bug Fixes

• lint (import order) (61cf4d7)

Chores

• ci: bump prism mock server version (#54) (7c2f07b)
• fix error message import example (#39) (275bdd3)
• internal: add type construction helper (#40) (8c8b921)
• internal: bump ruff version (#50) (4357329)
• internal: codegen related update (#37) (5427b56)
• internal: codegen related update (#48) (af27fe8)
• internal: codegen related update (#57) (a154150)
• internal: ensure package is importable in lint cmd (#55) (0a92c06)
• internal: remove deprecated ruff config (#52) (fa82a92)
• internal: test updates (#49) (f69e598)
• internal: update pydantic compat helper function (#51) (91e721c)
• tests: update prism version (#38) (c496af8)

Documentation

• api: updates to API spec (#53) (df694a3)
• api: updates to API spec (#58) (f69da53)

0.5.0 (2024-07-14)

Full Changelog: v0.4.0...v0.5.0

Features

• api: codegen changes (08baa7a)
• api: OpenAPI spec update via Stainless API (#29) (2f3b3f1)
• api: OpenAPI spec update via Stainless API (#31) (b59f86f)
• api: OpenAPI spec update via Stainless API (#33) (01fa9b6)
• api: update via SDK Studio (#32) (5dc4cba)

0.4.0 (2024-07-12)

Full Changelog: v0.3.0...v0.4.0

Features

• api: OpenAPI spec update via Stainless API (#25) (14d73d7)
• api: update via SDK Studio (#26) (3c48690)
• api: update via SDK Studio (#27) (773967a)

Bug Fixes

• client: correct file uploads setup (269d7e5)
• files: remove content_length argument (9a57374)
• pkg: remove unwanted files (270fe31)

0.3.0 (2024-07-12)

Full Changelog: v0.2.0...v0.3.0

Features

• api: update via SDK Studio (#20) (018271a)

0.2.0 (2024-07-10)

Full Changelog: v0.1.2...v0.2.0

Features

• api: add support for graphs and files endpoints (#15) (173c935)
• api: OpenAPI spec update via Stainless API (#10) (35aa63d)
• api: update via SDK Studio (#16) (55beac6)
• api: update via SDK Studio (#17) (e098020)
• api: update via SDK Studio (#18) (ca78421)
• Update completions_streaming.py (764b30e)
• Update completions_streaming.py (00c67cc)

0.1.2 (2024-06-05)

Full Changelog: v0.1.0...v0.1.2

Features

• api: update via SDK Studio (#7) (84a564e)
• api: update via SDK Studio (#8) (c0594c3)

Chores

• internal: version bump (#5) (2252270)

0.1.0 (2024-06-05)

Full Changelog: v0.1.0-alpha.3...v0.1.0

Features

• api: update via SDK Studio (fe993a2)
• api: update via SDK Studio (#10) (6ebe199)
• api: update via SDK Studio (#12) (e668e94)
• api: update via SDK Studio (#13) (aa08d76)
• api: update via SDK Studio (#14) (87ce38f)
• api: update via SDK Studio (#3) (3c3ae55)
• api: update via SDK Studio (#4) (2523970)

Chores

• go live (#2) (f812fc4)

0.1.0-alpha.3 (2024-05-24)

Full Changelog: v0.1.0-alpha.2...v0.1.0-alpha.3

Features

• api: update via SDK Studio (#7) (c65c32f)

0.1.0-alpha.2 (2024-05-16)

Full Changelog: v0.1.0-alpha.1...v0.1.0-alpha.2

Features

• api: update via SDK Studio (#4) (b37cf96)

0.1.0-alpha.1 (2024-05-15)

Full Changelog: v0.0.1-alpha.0...v0.1.0-alpha.1

Features

• api: update via SDK Studio (e08da9a)
• api: update via SDK Studio (44878c4)
• api: update via SDK Studio (d28feb5)
• api: update via SDK Studio (f192140)
• api: update via SDK Studio (4ac2e51)
• api: update via SDK Studio (bf82bf0)
• api: update via SDK Studio (c863077)
• api: update via SDK Studio (3134c2b)
• api: update via SDK Studio (c63add4)

Chores

• go live (#1) (8f24e96)