release: 0.37.0

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
     timeout-minutes: 10
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/hyperspell-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
     steps:
       - uses: actions/checkout@v6
 
@@ -35,7 +35,7 @@ jobs:
         run: ./scripts/lint
 
   build:
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
     timeout-minutes: 10
     name: build
     permissions:

.gitignore

@@ -1,4 +1,5 @@
 .prism.log
+.stdy.log
 _dev
 
 __pycache__

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.36.0"
+  ".": "0.37.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 30
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-b1f2b7cb843e6f4e6123e838ce29cbbaea0a48b1a72057632de1d0d21727c5d8.yml
-openapi_spec_hash: 21a354f587a2fe19797860c7b6da81a9
-config_hash: 0ed970a9634b33d0af471738b478740d
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-460d7c66cd5e8cf979cd761066c51d8f813a119a20e2149fcfcf847eb650d545.yml
+openapi_spec_hash: 8ee512464a88de45c86faf4f46f4905c
+config_hash: bd8505e17db740d82e578d0edaa9bfe0

CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 0.37.0 (2026-04-11)
+
+Full Changelog: [v0.36.0...v0.37.0](https://github.com/hyperspell/python-sdk/compare/v0.36.0...v0.37.0)
+
+### Features
+
+* **api:** api update ([7db075c](https://github.com/hyperspell/python-sdk/commit/7db075c464314b7077bc555b57ef65e63e464594))
+* **api:** api update ([4865c08](https://github.com/hyperspell/python-sdk/commit/4865c08579bd2750a17976036da5b513e167112b))
+* **api:** api update ([13e0682](https://github.com/hyperspell/python-sdk/commit/13e068243400026b7c8e11b11fdca6ba89a2460e))
+* **api:** api update ([a0f4720](https://github.com/hyperspell/python-sdk/commit/a0f47209c51eb35cf31974bc158cf9e4df29c0ec))
+* **api:** api update ([d3e77c3](https://github.com/hyperspell/python-sdk/commit/d3e77c368350f9a22469db6574d3a44159a043c9))
+* **api:** api update ([6180902](https://github.com/hyperspell/python-sdk/commit/618090275519b615d2f0b4679aecb9a86ccbab0b))
+* **internal:** implement indices array format for query and form serialization ([0e1fd91](https://github.com/hyperspell/python-sdk/commit/0e1fd91815afe92b4b7ba73f96e196aa71d5f8c5))
+
+
+### Bug Fixes
+
+* **client:** preserve hardcoded query params when merging with user params ([c314c08](https://github.com/hyperspell/python-sdk/commit/c314c08b0c99131cd98a404ede9416d6c3ff47e3))
+* ensure file data are only sent as 1 parameter ([48cbd64](https://github.com/hyperspell/python-sdk/commit/48cbd64319e2eab5b2915858e47662a84e7e0e76))
+* sanitize endpoint path params ([b2b3ca2](https://github.com/hyperspell/python-sdk/commit/b2b3ca2749930db6558bbe5bc3bb1ce4adadfe0e))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([b5a6b2d](https://github.com/hyperspell/python-sdk/commit/b5a6b2d8467b72cc0bfa192cf2bfd2966de6190e))
+* **internal:** update gitignore ([8f27c46](https://github.com/hyperspell/python-sdk/commit/8f27c46407285a62b885632d2bb3c6059ec91eb2))
+* **tests:** bump steady to v0.19.4 ([a855b0a](https://github.com/hyperspell/python-sdk/commit/a855b0a42e5926bdb4c1ece32f74370f9b481241))
+* **tests:** bump steady to v0.19.5 ([7ea97c0](https://github.com/hyperspell/python-sdk/commit/7ea97c0c00ee4d81301a6b2214ed677e88a5fcd8))
+* **tests:** bump steady to v0.19.6 ([1ecd0bf](https://github.com/hyperspell/python-sdk/commit/1ecd0bfd11ca3de3436524145c5df5c20b2ec2eb))
+* **tests:** bump steady to v0.19.7 ([466a814](https://github.com/hyperspell/python-sdk/commit/466a8145d00c3810bd1d83ac8531c719377100b8))
+* **tests:** bump steady to v0.20.1 ([74c3b3b](https://github.com/hyperspell/python-sdk/commit/74c3b3b7867b0fef233c314c776c5d867f66937a))
+* **tests:** bump steady to v0.20.2 ([3eb71a2](https://github.com/hyperspell/python-sdk/commit/3eb71a2ea44943f9b2e10073292d7fd4d58c1b43))
+
+
+### Documentation
+
+* update examples ([2859f14](https://github.com/hyperspell/python-sdk/commit/2859f147d2331d1371a1fb61051e89a23e51c077))
+
+
+### Refactors
+
+* **tests:** switch from prism to steady ([441e854](https://github.com/hyperspell/python-sdk/commit/441e854a4933f7abd07961f08a58d7f7b7b3ea60))
+
 ## 0.36.0 (2026-03-18)
 
 Full Changelog: [v0.35.0...v0.36.0](https://github.com/hyperspell/python-sdk/compare/v0.35.0...v0.36.0)

CONTRIBUTING.md

@@ -85,7 +85,7 @@ $ pip install ./path-to-wheel-file.whl
 
 ## Running tests
 
-Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+Most tests require you to [set up a mock server](https://github.com/dgellow/steady) against the OpenAPI spec to run the tests.
 
 ```sh
 $ ./scripts/mock

README.md

@@ -42,7 +42,7 @@ client = Hyperspell(
 )
 
 memory_status = client.memories.add(
-    text="text",
+    text="...",
 )
 print(memory_status.resource_id)
 ```
@@ -68,7 +68,7 @@ client = AsyncHyperspell(
 
 async def main() -> None:
     memory_status = await client.memories.add(
-        text="text",
+        text="...",
     )
     print(memory_status.resource_id)
 
@@ -104,7 +104,7 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         memory_status = await client.memories.add(
-            text="text",
+            text="...",
         )
         print(memory_status.resource_id)
 
@@ -194,8 +194,8 @@ from hyperspell import Hyperspell
 client = Hyperspell()
 
 query_result = client.memories.search(
-    query="query",
-    options={},
+    query="What does Hyperspell do?",
+    options={"filter": {}},
 )
 print(query_result.options)
 ```
@@ -234,7 +234,7 @@ client = Hyperspell()
 
 try:
     client.memories.add(
-        text="text",
+        text="...",
     )
 except hyperspell.APIConnectionError as e:
     print("The server could not be reached")
@@ -279,7 +279,7 @@ client = Hyperspell(
 
 # Or, configure per-request:
 client.with_options(max_retries=5).memories.add(
-    text="text",
+    text="...",
 )
 ```
 
@@ -304,7 +304,7 @@ client = Hyperspell(
 
 # Override per-request:
 client.with_options(timeout=5.0).memories.add(
-    text="text",
+    text="...",
 )
 ```
 
@@ -347,7 +347,7 @@ from hyperspell import Hyperspell
 
 client = Hyperspell()
 response = client.memories.with_raw_response.add(
-    text="text",
+    text="...",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -367,7 +367,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.memories.with_streaming_response.add(
-    text="text",
+    text="...",
 ) as response:
     print(response.headers.get("X-My-Header"))
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hyperspell"
-version = "0.36.0"
+version = "0.37.0"
 description = "The official Python library for the hyperspell API"
 dynamic = ["readme"]
 license = "MIT"

scripts/mock

@@ -19,34 +19,34 @@ fi
 
 echo "==> Starting mock server with URL ${URL}"
 
-# Run prism mock on the given spec
+# Run steady mock on the given spec
 if [ "$1" == "--daemon" ]; then
   # Pre-install the package so the download doesn't eat into the startup timeout
-  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism --version
+  npm exec --package=@stdy/cli@0.20.2 -- steady --version
 
-  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log &
 
-  # Wait for server to come online (max 30s)
+  # Wait for server to come online via health endpoint (max 30s)
   echo -n "Waiting for server"
   attempts=0
-  while ! grep -q "✖  fatal\|Prism is listening" ".prism.log" ; do
+  while ! curl --silent --fail "http://127.0.0.1:4010/_x-steady/health" >/dev/null 2>&1; do
+    if ! kill -0 $! 2>/dev/null; then
+      echo
+      cat .stdy.log
+      exit 1
+    fi
     attempts=$((attempts + 1))
     if [ "$attempts" -ge 300 ]; then
       echo
-      echo "Timed out waiting for Prism server to start"
-      cat .prism.log
+      echo "Timed out waiting for Steady server to start"
+      cat .stdy.log
       exit 1
     fi
     echo -n "."
     sleep 0.1
   done
 
-  if grep -q "✖  fatal" ".prism.log"; then
-    cat .prism.log
-    exit 1
-  fi
-
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
+  npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL"
 fi

scripts/test

@@ -9,8 +9,8 @@ GREEN='\033[0;32m'
 YELLOW='\033[0;33m'
 NC='\033[0m' # No Color
 
-function prism_is_running() {
-  curl --silent "http://localhost:4010" >/dev/null 2>&1
+function steady_is_running() {
+  curl --silent "http://127.0.0.1:4010/_x-steady/health" >/dev/null 2>&1
 }
 
 kill_server_on_port() {
@@ -25,7 +25,7 @@ function is_overriding_api_base_url() {
   [ -n "$TEST_API_BASE_URL" ]
 }
 
-if ! is_overriding_api_base_url && ! prism_is_running ; then
+if ! is_overriding_api_base_url && ! steady_is_running ; then
   # When we exit this script, make sure to kill the background mock server process
   trap 'kill_server_on_port 4010' EXIT
 
@@ -36,19 +36,19 @@ fi
 if is_overriding_api_base_url ; then
   echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}"
   echo
-elif ! prism_is_running ; then
-  echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Prism server"
+elif ! steady_is_running ; then
+  echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Steady server"
   echo -e "running against your OpenAPI spec."
   echo
   echo -e "To run the server, pass in the path or url of your OpenAPI"
-  echo -e "spec to the prism command:"
+  echo -e "spec to the steady command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stdy/cli@0.20.2 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}"
   echo
 
   exit 1
 else
-  echo -e "${GREEN}✔ Mock prism server is running with your OpenAPI spec${NC}"
+  echo -e "${GREEN}✔ Mock steady server is running with your OpenAPI spec${NC}"
   echo
 fi
 

src/hyperspell/_base_client.py

@@ -540,6 +540,10 @@ def _build_request(
                 files = cast(HttpxRequestFiles, ForceMultipartDict())
 
         prepared_url = self._prepare_url(options.url)
+        # preserve hard-coded query params from the url
+        if params and prepared_url.query:
+            params = {**dict(prepared_url.params.items()), **params}
+            prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0])
         if "_" in prepared_url.host:
             # work around https://github.com/encode/httpx/discussions/2880
             kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")}

src/hyperspell/_qs.py

@@ -101,7 +101,10 @@ def _stringify_item(
                     items.extend(self._stringify_item(key, item, opts))
                 return items
             elif array_format == "indices":
-                raise NotImplementedError("The array indices format is not supported yet")
+                items = []
+                for i, item in enumerate(value):
+                    items.extend(self._stringify_item(f"{key}[{i}]", item, opts))
+                return items
             elif array_format == "brackets":
                 items = []
                 key = key + "[]"

src/hyperspell/_utils/__init__.py

@@ -1,3 +1,4 @@
+from ._path import path_template as path_template
 from ._sync import asyncify as asyncify
 from ._proxy import LazyProxy as LazyProxy
 from ._utils import (