Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.5.0"
".": "0.6.0"
}
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 12
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-c99d72d8d845f1eeabf7a716949a12408df952a2a0ca2b97df570da3a7c8bb49.yml
openapi_spec_hash: 8a503cbccc8a5741554282327a557114
config_hash: 38a89a860ee0f5ef4f2cb10d010e4e8f
config_hash: 433e7a5579323a048aa173a0ace06bfc
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 0.6.0 (2026-02-08)

Full Changelog: [v0.5.0...v0.6.0](https://github.com/warpdotdev/oz-sdk-python/compare/v0.5.0...v0.6.0)

### Features

* **api:** manual updates ([75fe5e5](https://github.com/warpdotdev/oz-sdk-python/commit/75fe5e5c5ea9e044895c1bd7f1c5ab150214c8e7))

## 0.5.0 (2026-02-08)

Full Changelog: [v0.4.0...v0.5.0](https://github.com/warpdotdev/oz-sdk-python/compare/v0.4.0...v0.5.0)
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ $ pip install -r requirements-dev.lock

Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
result in merge conflicts between manual patches and changes from the generator. The generator will never
modify the contents of the `src/warp_agent_sdk/lib/` and `examples/` directories.
modify the contents of the `src/oz_agent_sdk/lib/` and `examples/` directories.

## Adding and running examples

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2026 Warp API
Copyright 2026 Oz API

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
78 changes: 39 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Warp API Python API library
# Oz API Python API library

<!-- prettier-ignore -->
[![PyPI version](https://img.shields.io/pypi/v/oz-agent-sdk.svg?label=pypi%20(stable))](https://pypi.org/project/oz-agent-sdk/)

The Warp API Python library provides convenient access to the Warp API REST API from any Python 3.9+
The Oz API Python library provides convenient access to the Oz API REST API from any Python 3.9+
application. The library includes type definitions for all request params and response fields,
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).

Expand All @@ -26,9 +26,9 @@ The full API of this library can be found in [api.md](api.md).

```python
import os
from warp_agent_sdk import WarpAPI
from oz_agent_sdk import OzAPI

client = WarpAPI(
client = OzAPI(
api_key=os.environ.get("WARP_API_KEY"), # This is the default and can be omitted
)

Expand Down Expand Up @@ -103,14 +103,14 @@ so that your API Key is not stored in source control.

## Async usage

Simply import `AsyncWarpAPI` instead of `WarpAPI` and use `await` with each API call:
Simply import `AsyncOzAPI` instead of `OzAPI` and use `await` with each API call:

```python
import os
import asyncio
from warp_agent_sdk import AsyncWarpAPI
from oz_agent_sdk import AsyncOzAPI

client = AsyncWarpAPI(
client = AsyncOzAPI(
api_key=os.environ.get("WARP_API_KEY"), # This is the default and can be omitted
)

Expand Down Expand Up @@ -143,12 +143,12 @@ Then you can enable it by instantiating the client with `http_client=DefaultAioH
```python
import os
import asyncio
from warp_agent_sdk import DefaultAioHttpClient
from warp_agent_sdk import AsyncWarpAPI
from oz_agent_sdk import DefaultAioHttpClient
from oz_agent_sdk import AsyncOzAPI


async def main() -> None:
async with AsyncWarpAPI(
async with AsyncOzAPI(
api_key=os.environ.get("WARP_API_KEY"), # This is the default and can be omitted
http_client=DefaultAioHttpClient(),
) as client:
Expand All @@ -175,9 +175,9 @@ Typed requests and responses provide autocomplete and documentation within your
Nested parameters are dictionaries, typed using `TypedDict`, for example:

```python
from warp_agent_sdk import WarpAPI
from oz_agent_sdk import OzAPI

client = WarpAPI()
client = OzAPI()

response = client.agent.run(
config={},
Expand All @@ -187,29 +187,29 @@ print(response.config)

## 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 `warp_agent_sdk.APIConnectionError` is raised.
When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `oz_agent_sdk.APIConnectionError` is raised.

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

All errors inherit from `warp_agent_sdk.APIError`.
All errors inherit from `oz_agent_sdk.APIError`.

```python
import warp_agent_sdk
from warp_agent_sdk import WarpAPI
import oz_agent_sdk
from oz_agent_sdk import OzAPI

client = WarpAPI()
client = OzAPI()

try:
client.agent.run(
prompt="Fix the bug in auth.go",
)
except warp_agent_sdk.APIConnectionError as e:
except oz_agent_sdk.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except warp_agent_sdk.RateLimitError as e:
except oz_agent_sdk.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except warp_agent_sdk.APIStatusError as e:
except oz_agent_sdk.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)
Expand Down Expand Up @@ -237,10 +237,10 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
You can use the `max_retries` option to configure or disable retry settings:

```python
from warp_agent_sdk import WarpAPI
from oz_agent_sdk import OzAPI

# Configure the default for all requests:
client = WarpAPI(
client = OzAPI(
# default is 2
max_retries=0,
)
Expand All @@ -257,16 +257,16 @@ By default requests time out after 1 minute. You can configure this with a `time
which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:

```python
from warp_agent_sdk import WarpAPI
from oz_agent_sdk import OzAPI

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

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

Expand All @@ -286,10 +286,10 @@ Note that requests that time out are [retried twice by default](#retries).

We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.

You can enable logging by setting the environment variable `WARP_API_LOG` to `info`.
You can enable logging by setting the environment variable `OZ_API_LOG` to `info`.

```shell
$ export WARP_API_LOG=info
$ export OZ_API_LOG=info
```

Or to `debug` for more verbose logging.
Expand All @@ -311,9 +311,9 @@ if response.my_field is None:
The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,

```py
from warp_agent_sdk import WarpAPI
from oz_agent_sdk import OzAPI

client = WarpAPI()
client = OzAPI()
response = client.agent.with_raw_response.run(
prompt="Fix the bug in auth.go",
)
Expand All @@ -323,9 +323,9 @@ agent = response.parse() # get the object that `agent.run()` would have returne
print(agent.run_id)
```

These methods return an [`APIResponse`](https://github.com/warpdotdev/oz-sdk-python/tree/main/src/warp_agent_sdk/_response.py) object.
These methods return an [`APIResponse`](https://github.com/warpdotdev/oz-sdk-python/tree/main/src/oz_agent_sdk/_response.py) object.

The async client returns an [`AsyncAPIResponse`](https://github.com/warpdotdev/oz-sdk-python/tree/main/src/warp_agent_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
The async client returns an [`AsyncAPIResponse`](https://github.com/warpdotdev/oz-sdk-python/tree/main/src/oz_agent_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.

#### `.with_streaming_response`

Expand Down Expand Up @@ -389,10 +389,10 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c

```python
import httpx
from warp_agent_sdk import WarpAPI, DefaultHttpxClient
from oz_agent_sdk import OzAPI, DefaultHttpxClient

client = WarpAPI(
# Or use the `WARP_API_BASE_URL` env var
client = OzAPI(
# Or use the `OZ_API_BASE_URL` env var
base_url="http://my.test.server.example.com:8083",
http_client=DefaultHttpxClient(
proxy="http://my.test.proxy.example.com",
Expand All @@ -412,9 +412,9 @@ client.with_options(http_client=DefaultHttpxClient(...))
By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.

```py
from warp_agent_sdk import WarpAPI
from oz_agent_sdk import OzAPI

with WarpAPI() as client:
with OzAPI() as client:
# make requests here
...

Expand All @@ -440,8 +440,8 @@ If you've upgraded to the latest version but aren't seeing any new features you
You can determine the version that is being used at runtime with:

```py
import warp_agent_sdk
print(warp_agent_sdk.__version__)
import oz_agent_sdk
print(oz_agent_sdk.__version__)
```

## Requirements
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ before making any information public.
## Reporting Non-SDK Related Security Issues

If you encounter security issues that are not directly related to SDKs but pertain to the services
or products provided by Warp API, please follow the respective company's security reporting guidelines.
or products provided by Oz API, please follow the respective company's security reporting guidelines.

---

Expand Down
30 changes: 15 additions & 15 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Types:

```python
from warp_agent_sdk.types import (
from oz_agent_sdk.types import (
AgentSkill,
AmbientAgentConfig,
CloudEnvironmentConfig,
Expand All @@ -16,15 +16,15 @@ from warp_agent_sdk.types import (

Methods:

- <code title="get /agent">client.agent.<a href="./src/warp_agent_sdk/resources/agent/agent.py">list</a>(\*\*<a href="src/warp_agent_sdk/types/agent_list_params.py">params</a>) -> <a href="./src/warp_agent_sdk/types/agent_list_response.py">AgentListResponse</a></code>
- <code title="post /agent/run">client.agent.<a href="./src/warp_agent_sdk/resources/agent/agent.py">run</a>(\*\*<a href="src/warp_agent_sdk/types/agent_run_params.py">params</a>) -> <a href="./src/warp_agent_sdk/types/agent_run_response.py">AgentRunResponse</a></code>
- <code title="get /agent">client.agent.<a href="./src/oz_agent_sdk/resources/agent/agent.py">list</a>(\*\*<a href="src/oz_agent_sdk/types/agent_list_params.py">params</a>) -> <a href="./src/oz_agent_sdk/types/agent_list_response.py">AgentListResponse</a></code>
- <code title="post /agent/run">client.agent.<a href="./src/oz_agent_sdk/resources/agent/agent.py">run</a>(\*\*<a href="src/oz_agent_sdk/types/agent_run_params.py">params</a>) -> <a href="./src/oz_agent_sdk/types/agent_run_response.py">AgentRunResponse</a></code>

## Runs

Types:

```python
from warp_agent_sdk.types.agent import (
from oz_agent_sdk.types.agent import (
ArtifactItem,
RunItem,
RunSourceType,
Expand All @@ -36,16 +36,16 @@ from warp_agent_sdk.types.agent import (

Methods:

- <code title="get /agent/runs/{runId}">client.agent.runs.<a href="./src/warp_agent_sdk/resources/agent/runs.py">retrieve</a>(run_id) -> <a href="./src/warp_agent_sdk/types/agent/run_item.py">RunItem</a></code>
- <code title="get /agent/runs">client.agent.runs.<a href="./src/warp_agent_sdk/resources/agent/runs.py">list</a>(\*\*<a href="src/warp_agent_sdk/types/agent/run_list_params.py">params</a>) -> <a href="./src/warp_agent_sdk/types/agent/run_list_response.py">RunListResponse</a></code>
- <code title="post /agent/runs/{runId}/cancel">client.agent.runs.<a href="./src/warp_agent_sdk/resources/agent/runs.py">cancel</a>(run_id) -> str</code>
- <code title="get /agent/runs/{runId}">client.agent.runs.<a href="./src/oz_agent_sdk/resources/agent/runs.py">retrieve</a>(run_id) -> <a href="./src/oz_agent_sdk/types/agent/run_item.py">RunItem</a></code>
- <code title="get /agent/runs">client.agent.runs.<a href="./src/oz_agent_sdk/resources/agent/runs.py">list</a>(\*\*<a href="src/oz_agent_sdk/types/agent/run_list_params.py">params</a>) -> <a href="./src/oz_agent_sdk/types/agent/run_list_response.py">RunListResponse</a></code>
- <code title="post /agent/runs/{runId}/cancel">client.agent.runs.<a href="./src/oz_agent_sdk/resources/agent/runs.py">cancel</a>(run_id) -> str</code>

## Schedules

Types:

```python
from warp_agent_sdk.types.agent import (
from oz_agent_sdk.types.agent import (
ScheduledAgentItem,
ScheduleListResponse,
ScheduleDeleteResponse,
Expand All @@ -54,10 +54,10 @@ from warp_agent_sdk.types.agent import (

Methods:

- <code title="post /agent/schedules">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">create</a>(\*\*<a href="src/warp_agent_sdk/types/agent/schedule_create_params.py">params</a>) -> <a href="./src/warp_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="get /agent/schedules/{scheduleId}">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">retrieve</a>(schedule_id) -> <a href="./src/warp_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="put /agent/schedules/{scheduleId}">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">update</a>(schedule_id, \*\*<a href="src/warp_agent_sdk/types/agent/schedule_update_params.py">params</a>) -> <a href="./src/warp_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="get /agent/schedules">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">list</a>() -> <a href="./src/warp_agent_sdk/types/agent/schedule_list_response.py">ScheduleListResponse</a></code>
- <code title="delete /agent/schedules/{scheduleId}">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">delete</a>(schedule_id) -> <a href="./src/warp_agent_sdk/types/agent/schedule_delete_response.py">ScheduleDeleteResponse</a></code>
- <code title="post /agent/schedules/{scheduleId}/pause">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">pause</a>(schedule_id) -> <a href="./src/warp_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="post /agent/schedules/{scheduleId}/resume">client.agent.schedules.<a href="./src/warp_agent_sdk/resources/agent/schedules.py">resume</a>(schedule_id) -> <a href="./src/warp_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="post /agent/schedules">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">create</a>(\*\*<a href="src/oz_agent_sdk/types/agent/schedule_create_params.py">params</a>) -> <a href="./src/oz_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="get /agent/schedules/{scheduleId}">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">retrieve</a>(schedule_id) -> <a href="./src/oz_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="put /agent/schedules/{scheduleId}">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">update</a>(schedule_id, \*\*<a href="src/oz_agent_sdk/types/agent/schedule_update_params.py">params</a>) -> <a href="./src/oz_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="get /agent/schedules">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">list</a>() -> <a href="./src/oz_agent_sdk/types/agent/schedule_list_response.py">ScheduleListResponse</a></code>
- <code title="delete /agent/schedules/{scheduleId}">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">delete</a>(schedule_id) -> <a href="./src/oz_agent_sdk/types/agent/schedule_delete_response.py">ScheduleDeleteResponse</a></code>
- <code title="post /agent/schedules/{scheduleId}/pause">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">pause</a>(schedule_id) -> <a href="./src/oz_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
- <code title="post /agent/schedules/{scheduleId}/resume">client.agent.schedules.<a href="./src/oz_agent_sdk/resources/agent/schedules.py">resume</a>(schedule_id) -> <a href="./src/oz_agent_sdk/types/agent/scheduled_agent_item.py">ScheduledAgentItem</a></code>
12 changes: 6 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[project]
name = "oz-agent-sdk"
version = "0.5.0"
description = "The official Python library for the warp-api API"
version = "0.6.0"
description = "The official Python library for the oz-api API"
dynamic = ["readme"]
license = "Apache-2.0"
authors = [
{ name = "Warp API", email = "" },
{ name = "Oz API", email = "" },
]

dependencies = [
Expand Down Expand Up @@ -86,7 +86,7 @@ include = [
]

[tool.hatch.build.targets.wheel]
packages = ["src/warp_agent_sdk"]
packages = ["src/oz_agent_sdk"]

[tool.hatch.build.targets.sdist]
# Basically everything except hidden files/directories (such as .github, .devcontainers, .python-version, etc)
Expand Down Expand Up @@ -154,7 +154,7 @@ show_error_codes = true
#
# We also exclude our `tests` as mypy doesn't always infer
# types correctly and Pyright will still catch any type errors.
exclude = ['src/warp_agent_sdk/_files.py', '_dev/.*.py', 'tests/.*']
exclude = ['src/oz_agent_sdk/_files.py', '_dev/.*.py', 'tests/.*']

strict_equality = true
implicit_reexport = true
Expand Down Expand Up @@ -246,7 +246,7 @@ length-sort = true
length-sort-straight = true
combine-as-imports = true
extra-standard-library = ["typing_extensions"]
known-first-party = ["warp_agent_sdk", "tests"]
known-first-party = ["oz_agent_sdk", "tests"]

[tool.ruff.lint.per-file-ignores]
"bin/**.py" = ["T201", "T203"]
Expand Down
2 changes: 1 addition & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,6 @@
],
"release-type": "python",
"extra-files": [
"src/warp_agent_sdk/_version.py"
"src/oz_agent_sdk/_version.py"
]
}
2 changes: 1 addition & 1 deletion scripts/lint
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ echo "==> Running mypy"
uv run mypy .

echo "==> Making sure it imports"
uv run python -c 'import warp_agent_sdk'
uv run python -c 'import oz_agent_sdk'
Loading