Skip to main content

Casedev Python API library

PyPI version

The Casedev Python library provides convenient access to the Casedev REST API from any Python 3.10+ application. The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.

It is generated with Stainless.

Documentation

The REST API documentation can be found on docs.case.dev. The full API of this library can be found in api.md.

Installation

# install from PyPI
pip install casedev

Usage

The full API of this library can be found in api.md.

import os
from casedev import Casedev

client = Casedev(
    api_key=os.environ.get("CASEDEV_API_KEY"),  # This is the default and can be omitted
    # defaults to "production".
    environment="local",
)

response = client.llm.v1.chat.create_completion(
    messages=[
        {
            "role": "user",
            "content": "Hello!",
        }
    ],
)
print(response.id)

While you can provide an api_key keyword argument, we recommend using python-dotenv to add CASEDEV_API_KEY="My API Key" to your .env file so that your API Key is not stored in source control.

Async usage

Simply import AsyncCasedev instead of Casedev and use await with each API call:

import os
import asyncio
from casedev import AsyncCasedev

client = AsyncCasedev(
    api_key=os.environ.get("CASEDEV_API_KEY"),  # This is the default and can be omitted
    # defaults to "production".
    environment="local",
)


async def main() -> None:
    response = await client.llm.v1.chat.create_completion(
        messages=[
            {
                "role": "user",
                "content": "Hello!",
            }
        ],
    )
    print(response.id)


asyncio.run(main())

Functionality between the synchronous and asynchronous clients is otherwise identical.

With aiohttp

By default, the async client uses httpx for HTTP requests. However, for improved concurrency performance you may also use aiohttp as the HTTP backend.

You can enable this by installing aiohttp:

# install from PyPI
pip install casedev[aiohttp]

Then you can enable it by instantiating the client with http_client=DefaultAioHttpClient():

import os
import asyncio
from casedev import DefaultAioHttpClient
from casedev import AsyncCasedev


async def main() -> None:
    async with AsyncCasedev(
        api_key=os.environ.get("CASEDEV_API_KEY"),  # This is the default and can be omitted
        http_client=DefaultAioHttpClient(),
    ) as client:
        response = await client.llm.v1.chat.create_completion(
            messages=[
                {
                    "role": "user",
                    "content": "Hello!",
                }
            ],
        )
        print(response.id)


asyncio.run(main())

Using types

Nested request parameters are TypedDicts. Responses are Pydantic models which also provide helper methods for things like:

  • Serializing back into JSON, model.to_json()
  • Converting to a dictionary, model.to_dict()

Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set python.analysis.typeCheckingMode to basic.

Nested params

Nested parameters are dictionaries, typed using TypedDict, for example:

from casedev import Casedev

client = Casedev()

response = client.connectors.v1.sync_link(
    connection_id="connection_id",
    direction="import",
    remote={"folder_id": "folder_id"},
    vault_id="vault_id",
)
print(response.remote)

File uploads

Request parameters that correspond to file uploads can be passed as bytes, or a PathLike instance or a tuple of (filename, contents, media type).

from pathlib import Path
from casedev import Casedev

client = Casedev()

client.translate.v1.translate_document(
    file=Path("/path/to/file"),
    target="es",
)

The async client uses the exact same interface. If you pass a PathLike instance, the file contents will be read asynchronously automatically.

Handling errors

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of casedev.APIConnectionError is raised.

When the API returns a non-success status code (that is, 4xx or 5xx response), a subclass of casedev.APIStatusError is raised, containing status_code and response properties.

All errors inherit from casedev.APIError.

import casedev
from casedev import Casedev

client = Casedev()

try:
    client.vault.create(
        name="My Vault",
    )
except casedev.APIConnectionError as e:
    print("The server could not be reached")
    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
except casedev.RateLimitError as e:
    print("A 429 status code was received; we should back off a bit.")
except casedev.APIStatusError as e:
    print("Another non-200-range status code was received")
    print(e.status_code)
    print(e.response)

Error codes are as follows:

Status Code Error Type
400 BadRequestError
401 AuthenticationError
403 PermissionDeniedError
404 NotFoundError
422 UnprocessableEntityError
429 RateLimitError
>=500 InternalServerError
N/A APIConnectionError

Retries

Certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors are all retried by default.

You can use the max_retries option to configure or disable retry settings:

from casedev import Casedev

# Configure the default for all requests:
client = Casedev(
    # default is 2
    max_retries=0,
)

# Or, configure per-request:
client.with_options(max_retries=5).vault.create(
    name="My Vault",
)

Timeouts

By default requests time out after 1 minute. You can configure this with a timeout option, which accepts a float or an httpx.Timeout object:

from casedev import Casedev

# Configure the default for all requests:
client = Casedev(
    # 20 seconds (default is 1 minute)
    timeout=20.0,
)

# More granular control:
client = Casedev(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

# Override per-request:
client.with_options(timeout=5.0).vault.create(
    name="My Vault",
)

On timeout, an APITimeoutError is thrown.

Note that requests that time out are retried twice by default.

Advanced

Logging

We use the standard library logging module.

You can enable logging by setting the environment variable CASEDEV_LOG to info.

$ export CASEDEV_LOG=info

Or to debug for more verbose logging.

How to tell whether None means null or missing

In an API response, a field may be explicitly null, or missing entirely; in either case, its value is None in this library. You can differentiate the two cases with .model_fields_set:

if response.my_field is None:
  if 'my_field' not in response.model_fields_set:
    print('Got json like {}, without a "my_field" key present at all.')
  else:
    print('Got json like {"my_field": null}.')

Accessing raw response data (e.g. headers)

The "raw" Response object can be accessed by prefixing .with_raw_response. to any HTTP method call, e.g.,

from casedev import Casedev

client = Casedev()
response = client.vault.with_raw_response.create(
    name="My Vault",
)
print(response.headers.get('X-My-Header'))

vault = response.parse()  # get the object that `vault.create()` would have returned
print(vault.id)

These methods return an APIResponse object.

The async client returns an AsyncAPIResponse with the same structure, the only difference being awaitable methods for reading the response content.

.with_streaming_response

The above interface eagerly reads the full response body when you make the request, which may not always be what you want.

To stream the response body, use .with_streaming_response instead, which requires a context manager and only reads the response body once you call .read(), .text(), .json(), .iter_bytes(), .iter_text(), .iter_lines() or .parse(). In the async client, these are async methods.

with client.vault.with_streaming_response.create(
    name="My Vault",
) as response:
    print(response.headers.get("X-My-Header"))

    for line in response.iter_lines():
        print(line)

The context manager is required so that the response will reliably be closed.

Making custom/undocumented requests

This library is typed for convenient access to the documented API.

If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can make requests using client.get, client.post, and other http verbs. Options on the client will be respected (such as retries) when making this request.

import httpx

response = client.post(
    "/foo",
    cast_to=httpx.Response,
    body={"my_param": True},
)

print(response.headers.get("x-foo"))

Undocumented request params

If you want to explicitly send an extra param, you can do so with the extra_query, extra_body, and extra_headers request options.

Undocumented response properties

To access undocumented response properties, you can access the extra fields like response.unknown_prop. You can also get all the extra fields on the Pydantic model as a dict with response.model_extra.

Configuring the HTTP client

You can directly override the httpx client to customize it for your use case, including:

import httpx
from casedev import Casedev, DefaultHttpxClient

client = Casedev(
    # Or use the `CASEDEV_BASE_URL` env var
    base_url="http://my.test.server.example.com:8083",
    http_client=DefaultHttpxClient(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

You can also customize the client on a per-request basis by using with_options():

client.with_options(http_client=DefaultHttpxClient(...))

Managing HTTP resources

By default the library closes underlying HTTP connections whenever the client is garbage collected. You can manually close the client using the .close() method if desired, or with a context manager that closes when exiting.

from casedev import Casedev

with Casedev() as client:
  # make requests here
  ...

# HTTP client is now closed

Versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes that only affect static types, without breaking runtime behavior.
  2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Determining the installed version

If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.

You can determine the version that is being used at runtime with:

import casedev
print(casedev.__version__)

Requirements

Python 3.10 or higher.

Breaking change: the next release containing this change drops Python 3.9 support so that the optional aiohttp client can use patched dependencies. Python 3.9 reached end of life on October 31, 2025 (PEP 596). Upgrade to Python 3.10 or higher before installing that release. Existing published SDK releases are unchanged; this support change requires release-owner review before merge and release.

Contributing

See the contributing documentation.

Metadata

Release files for casedev 0.76.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for casedev 0.76.0
File Size Uploaded Provenance Actions
casedev-0.76.0.tar.gz 446.1 kB Without provenance Details for casedev-0.76.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for casedev 0.76.0
File Interpreter ABI Platform Actions
casedev-0.76.0-py3-none-any.whl Python 3 none any Details for casedev-0.76.0-py3-none-any.whl

Total release size: 920.8 kB

Release files / casedev-0.76.0.tar.gz

Download URL casedev-0.76.0.tar.gz
Size 446.1 kB
Tags Source
SHA-256 checksum
How to use checksums
34c22596f1b110fbdcc20e57dc4709b4c0770e13a3399000822e3572c7d5ea24
BLAKE2b-256 checksum
How to use checksums
5681f11a8c648952cf1c5cfa26d4697747e021a284135cce102d9b61a2757084
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / casedev-0.76.0-py3-none-any.whl

Download URL casedev-0.76.0-py3-none-any.whl
Size 474.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8dc3dfb9fe05cdfaacbbd2a2edbecd98c2b4ddfa9c0e1775172622b38cef16b4
BLAKE2b-256 checksum
How to use checksums
90dcf83a6fcd7f4d3abb8b12e38fb234f8d52b167696470004cb8f794995bc3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for casedev 0.76.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.76.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page