release: 0.38.0

[stainless-app]

Automated Release PR

0.38.0 (2026-05-18)

Full Changelog: v0.37.0...v0.38.0

Features

• api: api update (edd9b41)
• api: api update (cc26c43)
• api: api update (aa0cc75)
• api: api update (335d028)
• api: api update (3b25c10)
• api: api update (92fd43a)
• api: api update (7a8e495)
• api: manual updates (23c9221)
• internal/types: support eagerly validating pydantic iterators (e47301a)
• support setting headers via env (eba0398)

Bug Fixes

• client: add missing f-string prefix in file type error message (6dbd3ec)
• use correct field name format for multipart file arrays (0f569cc)

Performance Improvements

• client: optimize file structure copying in multipart requests (c28640c)

Chores

• internal: more robust bootstrap script (d4a39dc)
• internal: reformat pyproject.toml (19a83c3)
• tests: bump steady to v0.22.1 (7d67d91)

---

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]

🧪 Testing

To try out this version of the SDK:

pip install 'https://pkg.stainless.com/s/hyperspell-python/edd9b41ea428964bb74381e415df2e3616c6a46e/hyperspell-0.37.0-py3-none-any.whl'

Expires at: Wed, 17 Jun 2026 23:31:38 GMT
Updated at: Mon, 18 May 2026 23:31:38 GMT

[canaries-inc]

🐤 Canary Summary

This PR is a Python SDK release with no UI/UX changes affecting end users:

• Version bump to 0.38.0 across all configuration files
• Added date parameter to memories API for backend ranking/filtering
• Updated API type definitions and test coverage
• No user-facing UI components or changes present

---

---

View PR tests on Canary

[canaries-inc]

🐤 Canary Proposed Tests

No testable user journeys found for this PR.

[entelligence-ai-pr-reviews]

---

Confidence Score: 5/5 - Safe to Merge

Safe to merge — this PR is a release bump to version 0.38.0 and the automated review found no issues across the reviewed files. No logic changes, security concerns, or correctness problems were identified, and there are no unresolved pre-existing comments to carry forward. The PR appears to be a standard version release with clean diffs.

Key Findings:

• No review comments were generated by the automated analysis, indicating no detectable logic, security, or correctness issues in the changed files.
• Zero critical, significant, or medium-severity issues were flagged by the heuristic analysis, consistent with a version bump or release preparation PR.
• Coverage of 3/8 changed files leaves some files unreviewed, but for a release PR this is a low-risk gap — typically release commits touch changelogs, version files, and lock files which are low-risk by nature.

[entelligence-ai-pr-reviews]

EntelligenceAI PR Summary

Release v0.38.0 of the Hyperspell Python SDK, delivering new integrations, API enhancements, infrastructure hardening, and internal utility refactors.

• Added five new integration providers (granola, fathom, linear, hubspot, salesforce) to all relevant type literals across resources, params, and response models
• Added HYPERSPELL_CUSTOM_HEADERS environment variable support in _client.py for both sync and async clients
• Introduced EagerIterable in _models.py for upfront Pydantic validation of generator/iterator fields
• Added deepcopy_with_paths in _files.py replacing deepcopy_minimal for targeted shallow copying along key paths
• Extended extract_files/_extract_items with array_format parameter (brackets, repeat, comma, indices) in _utils/_utils.py
• Refactored effort parameter in MemorySearchParams and memories.py from int to Literal['minimal', 'low', 'medium', 'high']
• Added date parameter to memory update methods and recency_half_life_days to search Options
• Added folder_ancestors field to shared/resource.py and requires_channel_selection to IntegrationListResponse
• Pinned all GitHub Actions to commit SHAs in CI/publish/release-doctor workflows
• Bumped @stdy/cli to 0.22.1 in mock/test scripts; fixed bootstrap unbound variable with ${SKIP_BREW:-}
• Centralized ArrayFormat/NestedFormat type aliases into _types.py; removed Literal import from _qs.py
• Updated MCP badge URLs in README to scoped package @hyperspell/hyperspell-mcp

---

Confidence Score: 3/5 - Review Recommended

Likely safe but review recommended — this PR delivers a well-scoped SDK release (v0.38.0) adding five new integration providers and several infrastructure improvements like HYPERSPELL_CUSTOM_HEADERS support and EagerIterable, all of which appear cleanly implemented. However, a pre-existing unresolved concern in _utils.py around the flattened_key handling in query parameter serialization remains open: when flattened_key is None and _array_suffix returns an empty string for 'repeat' or 'comma' formats, the recursive call receives flattened_key="" (empty string) instead of None, which could produce malformed query parameter keys with a leading separator. This correctness issue was not introduced by this PR but is unresolved and warrants explicit triage before shipping.

Key Findings:

• Unresolved correctness concern in src/hyperspell/_utils/_utils.py (L140-L151): passing flattened_key="" instead of None to a recursive serialization call when the key is absent could silently produce malformed query strings (e.g., =value or [0]=value instead of key=value), which would be a subtle runtime bug for callers using 'repeat' or 'comma' array formats.
• The new integration provider literals (granola, fathom, linear, hubspot, salesforce) appear to be additive-only changes to type literals, which are low-risk and backward-compatible additions that shouldn't introduce regressions.
• The HYPERSPELL_CUSTOM_HEADERS environment variable support added to _client.py for both sync and async clients is a meaningful feature addition; without seeing the review comments confirming proper parsing/sanitization, this is a potential area worth double-checking for header injection risks, though no explicit issue was flagged.
• 35 of 39 changed files were reviewed, leaving 4 files without coverage — given the unresolved issue in _utils.py, any unreviewd utility or client file deserves attention before merging.

Files requiring special attention

• src/hyperspell/_utils/_utils.py
• src/hyperspell/_client.py
• src/hyperspell/_models.py

[entelligence-ai-pr-reviews]

Releases v0.38.0 with a new date field on the memories update endpoint and a targeted deep copy utility replacing the previous full-copy approach in multipart requests.

• Added date: str | datetime | None parameter to sync/async memories.update() and MemoryUpdateParams
• Introduced deepcopy_with_paths in src/hyperspell/_files.py for selective container deep copying along specified key paths
• Removed deepcopy_minimal from src/hyperspell/_utils/_utils.py and its export from src/hyperspell/_utils/__init__.py
• Updated src/hyperspell/resources/memories.py to use deepcopy_with_paths with ['file'] path in both sync and async upload methods
• Added 8 new tests in tests/test_files.py covering deepcopy_with_paths and mutation-safety with extract_files
• Removed tests/test_deepcopy.py along with the deprecated utility
• Version bumped in pyproject.toml, _version.py, and .release-please-manifest.json; OpenAPI spec hash refreshed in .stats.yml

[entelligence-ai-pr-reviews]

Releases hyperspell v0.38.0 with an API enhancement, a deep copy performance improvement, and a test dependency update.

• Added optional date field (Union[str, datetime], ISO 8601) to MemoryUpdateParams and sync/async update methods in memories.py
• Replaced deepcopy_minimal (removed from _utils/_utils.py and _utils/__init__.py) with the new deepcopy_with_paths utility in _files.py, which shallow-copies only containers along specified key paths
• Updated memories.py upload methods to use deepcopy_with_paths imported from _files instead of _utils
• Bumped @stdy/cli from 0.20.2 to 0.22.1 in scripts/mock and scripts/test
• Updated OpenAPI spec URL/hash in .stats.yml
• Removed tests/test_deepcopy.py; added TestDeepcopyWithPaths tests in tests/test_files.py
• Version bumped to 0.38.0 in pyproject.toml, _version.py, and .release-please-manifest.json

[entelligence-ai-pr-reviews]

Release v0.38.0 of the hyperspell Python SDK introducing new API parameters, a custom headers environment variable, and internal utility improvements.

• Custom headers: Both sync and async clients now parse HYPERSPELL_CUSTOM_HEADERS (newline-delimited Key: Value) and merge into default_headers (src/hyperspell/_client.py)
• Array format control: extract_files / _extract_items gain an array_format parameter (brackets, indices, repeat, comma) controlling multipart field name suffixes (src/hyperspell/_utils/_utils.py)
• deepcopy refactor: Replaced deepcopy_minimal with deepcopy_with_paths for path-selective shallow copying; deepcopy_minimal removed from _utils exports (src/hyperspell/_files.py, src/hyperspell/_utils/__init__.py, src/hyperspell/resources/memories.py)
• New API parameters: date (ISO 8601) added to MemoryUpdateParams and memory update methods; recency_half_life_days added to Options in memory_search_params.py
• Type aliases relocated: ArrayFormat and NestedFormat moved from _qs.py to _types.py
• MCP badge URLs: Updated to scoped package name @hyperspell/hyperspell-mcp in README.md
• Scripts: Bootstrap hardened against set -u; @stdy/cli bumped to 0.22.1 in mock/test scripts
• Tests: Added coverage for array_format, deepcopy_with_paths, new API params; removed test_deepcopy.py

[entelligence-ai-pr-reviews]

Correctness: When flattened_key is None and _array_suffix returns "" (for "repeat" or "comma" formats), the new code passes flattened_key="" (empty string) to the recursive call instead of None; the downstream dict-handling branch checks if flattened_key is None to decide whether to assign key or append [key], so an empty string takes the else branch and produces a malformed key like "[fieldname]" instead of "fieldname".

🤖 AI Agent Prompt for Cursor/Windsurf

📋 Copy this prompt to your AI coding assistant (Cursor, Windsurf, etc.) to get help fixing this issue

In `src/hyperspell/_utils/_utils.py`, lines 142–144, the new expression `(flattened_key if flattened_key is not None else "") + _array_suffix(array_format, array_index)` converts a `None` flattened_key into an empty string `""` when `_array_suffix` returns `""` (e.g., for `"repeat"` or `"comma"` array formats). The recursive `_extract_items` call then sees `flattened_key=""`, which is not `None`, so the dict branch appends `[key]` instead of just using `key`, producing a leading-bracket malformed key. Fix by preserving `None` when the suffix is empty: use `(flattened_key + suffix) if flattened_key is not None else (suffix if suffix else None)` where `suffix = _array_suffix(array_format, array_index)`.