Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
842b67e
chore(ci): skip uploading artifacts on stainless-internal branches
stainless-app[bot] Mar 7, 2026
4420fda
fix(client): preserve URL params already embedded in path
stainless-app[bot] Mar 7, 2026
7d17121
chore(internal): update dependencies to address dependabot vulnerabil…
stainless-app[bot] Mar 9, 2026
e176700
chore(internal): tweak CI branches
stainless-app[bot] Mar 16, 2026
aef1e8f
codegen metadata
stainless-app[bot] Mar 20, 2026
71499fd
chore(internal): update gitignore
stainless-app[bot] Mar 23, 2026
096e999
chore(ci): skip lint on metadata-only changes
stainless-app[bot] Mar 24, 2026
e59522b
feat(api): api update
stainless-app[bot] Mar 24, 2026
df08fd5
codegen metadata
stainless-app[bot] Mar 24, 2026
ce640a2
codegen metadata
stainless-app[bot] Mar 24, 2026
0915c4a
codegen metadata
stainless-app[bot] Mar 24, 2026
82f94bc
codegen metadata
stainless-app[bot] Mar 24, 2026
ee86213
codegen metadata
stainless-app[bot] Mar 24, 2026
1914905
codegen metadata
stainless-app[bot] Mar 26, 2026
f79393c
feat: Use correct branch for Stainless PRs
stainless-app[bot] Mar 26, 2026
d9cddd6
feat(api): api update
stainless-app[bot] Mar 27, 2026
f69cb9f
feat: Add VMIdleTimeoutMinutes param to API
stainless-app[bot] Mar 27, 2026
36dd429
feat(api): api update
stainless-app[bot] Mar 27, 2026
de7b4ab
feat: Endpoint to upload third-party harness block snapshots
stainless-app[bot] Mar 31, 2026
b53c10e
codegen metadata
stainless-app[bot] Mar 31, 2026
c3689b5
codegen metadata
stainless-app[bot] Mar 31, 2026
0a7a253
feat: Address Stainless diagnostics
stainless-app[bot] Apr 1, 2026
64c6a1f
feat: Create run for every local conversation and add filter
stainless-app[bot] Apr 1, 2026
ca51f4c
codegen metadata
stainless-app[bot] Apr 1, 2026
29a9bf5
feat: Orchestrations V2: Public API endpoints
stainless-app[bot] Apr 2, 2026
8b53e4a
feat: Fix the harness type in the openAPI spec
stainless-app[bot] Apr 2, 2026
36fa2f7
feat: Add harness enum to openAPI spec
stainless-app[bot] Apr 2, 2026
b7784ca
release: 1.1.0-alpha.0
stainless-app[bot] Apr 2, 2026
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
26 changes: 16 additions & 10 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
name: CI
on:
push:
branches-ignore:
- 'generated'
- 'codegen/**'
- 'integrated/**'
- 'stl-preview-head/**'
- 'stl-preview-base/**'
branches:
- '**'
- '!integrated/**'
- '!stl-preview-head/**'
- '!stl-preview-base/**'
- '!generated'
- '!codegen/**'
- 'codegen/stl/**'
pull_request:
branches-ignore:
- 'stl-preview-head/**'
Expand All @@ -17,7 +19,7 @@ jobs:
timeout-minutes: 10
name: lint
runs-on: ${{ github.repository == 'stainless-sdks/warp-api-typescript' && '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

Expand All @@ -41,7 +43,7 @@ jobs:
timeout-minutes: 5
name: build
runs-on: ${{ github.repository == 'stainless-sdks/warp-api-typescript' && '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')
permissions:
contents: read
id-token: write
Expand All @@ -65,14 +67,18 @@ jobs:
run: ./scripts/build

- name: Get GitHub OIDC Token
if: github.repository == 'stainless-sdks/warp-api-typescript'
if: |-
github.repository == 'stainless-sdks/warp-api-typescript' &&
!startsWith(github.ref, 'refs/heads/stl/')
id: github-oidc
uses: actions/github-script@v8
with:
script: core.setOutput('github_token', await core.getIDToken());

- name: Upload tarball
if: github.repository == 'stainless-sdks/warp-api-typescript'
if: |-
github.repository == 'stainless-sdks/warp-api-typescript' &&
!startsWith(github.ref, 'refs/heads/stl/')
env:
URL: https://pkg.stainless.com/s
AUTH: ${{ steps.github-oidc.outputs.github_token }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.prism.log
.stdy.log
node_modules
yarn-error.log
codegen.log
Expand Down
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "1.0.2"
".": "1.1.0-alpha.0"
}
6 changes: 3 additions & 3 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 14
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-6c175d34cab49d79dbb24289ae516867404c42f3097264bbae171aced72ecc49.yml
openapi_spec_hash: 5abb55a1fc2836207bc88d4815f47f24
config_hash: a4b1ffc5b2e162efb3d557c7461153c1
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-7283a1794d3c59ddc27241892d1b962ee01c1bc5c0d9a456ff716c3d5e2420a7.yml
openapi_spec_hash: b8754eda5e237d0938d6b808fe33bf9b
config_hash: 1888db8b2f33dc16874aea51a90e78f7
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# Changelog

## 1.1.0-alpha.0 (2026-04-02)

Full Changelog: [v1.0.2...v1.1.0-alpha.0](https://github.com/warpdotdev/oz-sdk-typescript/compare/v1.0.2...v1.1.0-alpha.0)

### Features

* Add harness enum to openAPI spec ([36fa2f7](https://github.com/warpdotdev/oz-sdk-typescript/commit/36fa2f720d9cab9c7419d4e351dc200de2814cd3))
* Add VMIdleTimeoutMinutes param to API ([f69cb9f](https://github.com/warpdotdev/oz-sdk-typescript/commit/f69cb9fbd297f5c395eec28208d6ccee42125120))
* Address Stainless diagnostics ([0a7a253](https://github.com/warpdotdev/oz-sdk-typescript/commit/0a7a2535743f5a95d09b6491388b0faca79b11df))
* **api:** api update ([36dd429](https://github.com/warpdotdev/oz-sdk-typescript/commit/36dd42978291f15506666a1115ae98a6e3f87af4))
* **api:** api update ([d9cddd6](https://github.com/warpdotdev/oz-sdk-typescript/commit/d9cddd6e04aa60dcbdbf4fda5edcc7952520fe72))
* **api:** api update ([e59522b](https://github.com/warpdotdev/oz-sdk-typescript/commit/e59522b2d8335f3c72787a0d60e45017dbafd1b6))
* Create run for every local conversation and add filter ([64c6a1f](https://github.com/warpdotdev/oz-sdk-typescript/commit/64c6a1f34c49fc659e353ffee66b41d922caabfb))
* Endpoint to upload third-party harness block snapshots ([de7b4ab](https://github.com/warpdotdev/oz-sdk-typescript/commit/de7b4ab962b47f47554d5ba2c201930c15a595ac))
* Fix the harness type in the openAPI spec ([8b53e4a](https://github.com/warpdotdev/oz-sdk-typescript/commit/8b53e4ae6fe31f8f74e46297f8dea1edca375114))
* Orchestrations V2: Public API endpoints ([29a9bf5](https://github.com/warpdotdev/oz-sdk-typescript/commit/29a9bf58392ed3df54b1ec74e154f2e1f1aeeb6b))
* Use correct branch for Stainless PRs ([f79393c](https://github.com/warpdotdev/oz-sdk-typescript/commit/f79393caa4fbac92137f2b766957dd3b14b07f75))


### Bug Fixes

* **client:** preserve URL params already embedded in path ([4420fda](https://github.com/warpdotdev/oz-sdk-typescript/commit/4420fdab4fdc8cc948556b74d2370221528e1f47))


### Chores

* **ci:** skip lint on metadata-only changes ([096e999](https://github.com/warpdotdev/oz-sdk-typescript/commit/096e99986d06140c10c2fb43290b2d1e15501efd))
* **ci:** skip uploading artifacts on stainless-internal branches ([842b67e](https://github.com/warpdotdev/oz-sdk-typescript/commit/842b67ea7ff38e6032be0af5cdedef6c5f1b67a9))
* **internal:** tweak CI branches ([e176700](https://github.com/warpdotdev/oz-sdk-typescript/commit/e176700608c5bc5a1f928f07a03929f63bf6853e))
* **internal:** update dependencies to address dependabot vulnerabilities ([7d17121](https://github.com/warpdotdev/oz-sdk-typescript/commit/7d171218c88c717ddbe930cb6634d1387b685327))
* **internal:** update gitignore ([71499fd](https://github.com/warpdotdev/oz-sdk-typescript/commit/71499fd606505c058f5a8f41bbe20107181e9ab9))

## 1.0.2 (2026-03-06)

Full Changelog: [v1.0.1...v1.0.2](https://github.com/warpdotdev/oz-sdk-typescript/compare/v1.0.1...v1.0.2)
Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,37 @@ On timeout, an `APIConnectionTimeoutError` is thrown.

Note that requests which time out will be [retried twice by default](#retries).

## Auto-pagination

List methods in the OzAPI API are paginated.
You can use the `for await … of` syntax to iterate through items across all pages:

```ts
async function fetchAllRunItems(params) {
const allRunItems = [];
// Automatically fetches more pages as needed.
for await (const runItem of client.agent.runs.list()) {
allRunItems.push(runItem);
}
return allRunItems;
}
```

Alternatively, you can request a single page at a time:

```ts
let page = await client.agent.runs.list();
for (const runItem of page.runs) {
console.log(runItem);
}

// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
page = await page.getNextPage();
// ...
}
```

## Advanced Usage

### Accessing raw Response data (e.g., headers)
Expand Down
7 changes: 4 additions & 3 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ Types:

- <code><a href="./src/resources/agent/agent.ts">AgentSkill</a></code>
- <code><a href="./src/resources/agent/agent.ts">AmbientAgentConfig</a></code>
- <code><a href="./src/resources/agent/agent.ts">AwsProviderConfig</a></code>
- <code><a href="./src/resources/agent/agent.ts">CloudEnvironmentConfig</a></code>
- <code><a href="./src/resources/agent/agent.ts">Error</a></code>
- <code><a href="./src/resources/agent/agent.ts">ErrorCode</a></code>
- <code><a href="./src/resources/agent/agent.ts">GcpProviderConfig</a></code>
- <code><a href="./src/resources/agent/agent.ts">McpServerConfig</a></code>
- <code><a href="./src/resources/agent/agent.ts">Scope</a></code>
- <code><a href="./src/resources/agent/agent.ts">UserProfile</a></code>
Expand All @@ -18,7 +20,7 @@ Methods:

- <code title="get /agent">client.agent.<a href="./src/resources/agent/agent.ts">list</a>({ ...params }) -> AgentListResponse</code>
- <code title="get /agent/artifacts/{artifactUid}">client.agent.<a href="./src/resources/agent/agent.ts">getArtifact</a>(artifactUid) -> AgentGetArtifactResponse</code>
- <code title="post /agent/run">client.agent.<a href="./src/resources/agent/agent.ts">run</a>({ ...params }) -> AgentRunResponse</code>
- <code title="post /agent/runs">client.agent.<a href="./src/resources/agent/agent.ts">run</a>({ ...params }) -> AgentRunResponse</code>

## Runs

Expand All @@ -28,13 +30,12 @@ Types:
- <code><a href="./src/resources/agent/runs.ts">RunItem</a></code>
- <code><a href="./src/resources/agent/runs.ts">RunSourceType</a></code>
- <code><a href="./src/resources/agent/runs.ts">RunState</a></code>
- <code><a href="./src/resources/agent/runs.ts">RunListResponse</a></code>
- <code><a href="./src/resources/agent/runs.ts">RunCancelResponse</a></code>

Methods:

- <code title="get /agent/runs/{runId}">client.agent.runs.<a href="./src/resources/agent/runs.ts">retrieve</a>(runID) -> RunItem</code>
- <code title="get /agent/runs">client.agent.runs.<a href="./src/resources/agent/runs.ts">list</a>({ ...params }) -> RunListResponse</code>
- <code title="get /agent/runs">client.agent.runs.<a href="./src/resources/agent/runs.ts">list</a>({ ...params }) -> RunItemsRunsCursorPage</code>
- <code title="post /agent/runs/{runId}/cancel">client.agent.runs.<a href="./src/resources/agent/runs.ts">cancel</a>(runID) -> string</code>

## Schedules
Expand Down
13 changes: 12 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "oz-agent-sdk",
"version": "1.0.2",
"version": "1.1.0-alpha.0",
"description": "The official TypeScript library for the Oz API API",
"author": "Oz API <>",
"types": "dist/index.d.ts",
Expand Down Expand Up @@ -50,6 +50,17 @@
"typescript": "5.8.3",
"typescript-eslint": "8.31.1"
},
"overrides": {
"minimatch": "^9.0.5"
},
"pnpm": {
"overrides": {
"minimatch": "^9.0.5"
}
},
"resolutions": {
"minimatch": "^9.0.5"
},
"exports": {
".": {
"import": "./dist/index.mjs",
Expand Down
45 changes: 10 additions & 35 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading