Reference

Technical reference documentation for the Oz CLI, API, and SDK.

This section covers the programmatic interfaces for running and managing Oz agents in CI pipelines, scripts, backend services, and custom tooling.

CLI

The Oz CLI lets you run and configure agents from any environment — locally, in CI pipelines, or on remote machines.

• API Keys - Create and manage API keys to authenticate the Oz CLI without human interaction, ideal for CI pipelines, headless servers, and containers.

• Agent Profiles - Use agent profiles to control what the agent can access, how it behaves, and where it can act, including file access, command execution, and MCP server usage.

• MCP Servers - Pass MCP server configuration to agent runs using the --mcp flag, by UUID, inline JSON, or file path.

• Skills - Run agents from reusable instruction sets stored in your repositories using the --skill flag.

• Warp Drive Context - Reference saved prompts, notebooks, workflows, and rules from Warp Drive directly in CLI agent commands.

• Integration Setup - Configure environments and connect external tools like Slack and Linear so you can trigger Oz agents from outside the terminal.

• Troubleshooting - Find solutions to common CLI errors, including authentication issues, agent failures, environment problems, and Docker image issues.

API & SDK

The Oz Agent API lets you create and monitor cloud agent runs over HTTP. Official SDKs for Python and TypeScript provide typed clients with built-in retries and error handling.

• Demo: Sentry monitoring with SDK - example integration