Sarj.ai Platform SDK

Developer-friendly & type-safe Python SDK for the Sarj.ai Developer API.

Install

pip install sarj-platform-sdk

Quickstart

from sarj_platform_sdk import SDK

sdk = SDK(api_key_auth="<YOUR_API_KEY>")
res = sdk.system.get_health()
print(res.data.status)  # "ok"

Sign in at platform.sarj.ai and visit API Keys to generate a key.

Resource management

You don't need to manually close the SDK — httpx finalizes the underlying HTTP connection pool when sdk is garbage-collected. For deterministic cleanup in tests or short scripts, call sdk.close() (sync) or await sdk.aclose() (async) explicitly.

Summary

Sarj.ai Developer API: Public API for programmatic access to the Sarj.ai voice platform.

Authentication

All authenticated endpoints require a Bearer token in the Authorization header:

Authorization: Bearer <your-api-key>

Generate an API key from platform.sarj.ai/api-keys.

Response Format

Success

{
  "data": { ... },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}

Error

{
  "error": {
    "type": "unauthorized",
    "message": "Authentication required."
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}

Always branch on error.type — the message field is for humans only.

Support

Include meta.request_id in all support tickets for faster resolution.

For more information about the API: Sarj.ai Documentation

Table of Contents

• Sarj.ai Platform SDK
  • Install
  • Quickstart
  • Authentication
  • Response Format
  • Support
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add git+https://github.com/sarj-ai/platform.git#subdirectory=libraries/python/platform-sdk

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+https://github.com/sarj-ai/platform.git#subdirectory=libraries/python/platform-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+https://github.com/sarj-ai/platform.git#subdirectory=libraries/python/platform-sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from sarj-platform-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "sarj-platform-sdk",
# ]
# ///

from sarj_platform_sdk import SDK

sdk = SDK(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from sarj_platform_sdk import SDK


with SDK() as sdk:

    res = sdk.system.get_health()

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from sarj_platform_sdk import SDK

async def main():

    async with SDK() as sdk:

        res = await sdk.system.get_health_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the api_key_auth parameter must be set when initializing the SDK client instance. For example:

from sarj_platform_sdk import SDK


with SDK(
    api_key_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.system.get_health()

    # Handle response
    print(res)

Available Resources and Operations

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from sarj_platform_sdk import SDK
from sarj_platform_sdk.utils import BackoffStrategy, RetryConfig


with SDK() as sdk:

    res = sdk.system.get_health(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from sarj_platform_sdk import SDK
from sarj_platform_sdk.utils import BackoffStrategy, RetryConfig


with SDK(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as sdk:

    res = sdk.system.get_health()

    # Handle response
    print(res)

Error Handling

SDKError is the base class for all HTTP error responses. It has the following properties:

Example

from sarj_platform_sdk import SDK, errors


with SDK() as sdk:
    res = None
    try:

        res = sdk.system.get_health()

        # Handle response
        print(res)


    except errors.SDKError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ErrorResponse):
            print(e.data.error)  # models.Error
            print(e.data.meta)  # models.ResponseMeta

Error Classes

Primary errors:

• SDKError: The base class for HTTP error responses.
  • ErrorResponse: Standard envelope for all public API error responses. error is a discriminated union — branch on error.type to access variant-specific fields. Generated clients preserve unknown tagged variants so applications can log and surface newer server errors safely.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from sarj_platform_sdk import SDK


with SDK(
    server_url="https://platform-api.sarj.ai/api/v1",
) as sdk:

    res = sdk.system.get_health()

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from sarj_platform_sdk import SDK
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = SDK(client=http_client)

or you could wrap the client with your own custom logic:

from sarj_platform_sdk import SDK
from sarj_platform_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = SDK(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The SDK class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from sarj_platform_sdk import SDK
def main():

    with SDK() as sdk:
        # Rest of application here...


# Or when using async:
async def amain():

    async with SDK() as sdk:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from sarj_platform_sdk import SDK
import logging

logging.basicConfig(level=logging.DEBUG)
s = SDK(debug_logger=logging.getLogger("sarj_platform_sdk"))

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy