Warp OZ SDK (TypeScript)
https://github.com/warpdotdev/oz-sdk-typescript- Category
- Developer Tools
- Rank
- No. 1081Tools index
Previous survey · No. 1076 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- warpdotdev
- GitHub
- 26 stars
- Latest release
- v1.4.0-alpha.7
- Date
About
TypeScript SDK for Warp's agent platform, letting developers build and integrate with Warp's AI terminal agents.
What it does
A generated client library wraps Oz’s REST endpoints for server-side JavaScript and TypeScript. It handles authentication, agent run requests, environment settings, MCP server configuration, pagination, retries, timeouts, logging, and typed responses.
Why it's ranked here
The SDK covers the practical HTTP plumbing needed for production integrations, including typed errors, configurable retries, raw response access, and custom fetch support. Its focused surface is useful, though it remains a generated API client rather than a broader agent development framework.
What's good
Request and response definitions carry editor documentation, while automatic pagination reduces repetitive list-handling code. Errors preserve status, headers, and response bodies. Retry and timeout policies work globally or per request, and custom HTTP requests retain client options.
Tradeoffs
The client requires a Warp API key and expects a global fetch implementation unless one is supplied. Debug logging can expose sensitive request or response bodies. Types do not enforce undocumented parameters at runtime, and the README contains inconsistent package and response naming examples.
How to use it well
Use it in server-side TypeScript or JavaScript services that submit agent work, inspect runs, or configure execution environments and MCP connections. Set explicit timeout, retry, and logging policies. It does not create cloud environments, supply an agent runtime, or replace MCP servers.
Technical notes+
package.json defines the public oz-agent-sdk package, Apache-2.0 licensing, CommonJS packaging, separate import and require export maps, TypeScript declarations, and no runtime dependencies. src/index.ts exports the default OzAPI client plus promises, pagination, uploads, client options, and error classes. src/client.ts reads WARP_API_KEY, defaults to https://app.warp.dev/api/v1, uses bearer authentication, supports custom fetch and request options, and defaults to two retries with a one-minute timeout. src/core/error.ts maps common HTTP statuses to specific error subclasses. src/internal/parse.ts parses JSON by content type, handles empty responses, and returns text for other media types.
Observed
- License
- Apache-2.0
- Primary language
- TypeScript
- Install surface
- Public npm package named oz-agent-sdk
- Interface
- Server-side JavaScript and TypeScript library for the Oz REST API
- Module packaging
- CommonJS package with separate import and require export maps
- Runtime dependencies
- No production dependencies declared
- Authentication
- Bearer API key, with WARP_API_KEY used by default
- Generated source
- Client source states it is generated from an OpenAPI specification by Stainless
Read from README.md, package.json, src/index.ts, src/error.ts, src/client.ts, src/uploads.ts, src/version.ts, src/resource.ts, src/resources.ts, src/pagination.ts, src/api-promise.ts, src/core/error.ts, src/core/uploads.ts, src/core/resource.ts, src/internal/parse.ts.
What it can do
Initialize Warp AI terminal agent
Configuration parameters and API credentials → Active Warp agent instance
Send commands to AI terminal agent
Natural language command or query → Executed terminal commands or responses
Retrieve agent execution results
Agent task ID or session identifier → Command output, status, and metadata
Configure agent behavior and permissions
Agent settings and security constraints → Updated agent configuration
Monitor agent activity and logs
Agent instance or session → Real-time activity logs and status updates
Integrate Warp agents into existing applications
TypeScript application code and Warp SDK methods → Application with embedded AI terminal capabilities
Tags
Tech Stack
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.