oz-agent-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4588539e5a81dcbb25086df63b65d44f8ba647f93dab969f281d430daf10b47a
+  data.tar.gz: cd64be47a467a2289ade7563681fed0b24d640d52b7cb478c660b19c26452ac1
+SHA512:
+  metadata.gz: 51e8f3acf7aee995b415468c18aa1a531ce2361b473a2ccb126d5c5ae4eb1c3acc30b6c843be352c61f61680566afebf133b7e3d0a63acd3a30b11573e92f228
+  data.tar.gz: b459cd4e0b98b188a7ff1f8cb40b19185f3da66b7d408772e5e7b11ad1d7eb6ba67591ac6226e5abbac46b1f9114f45954179ecacb9c88336cc6a2692afc61a1

data/AGENTS.md

@@ -0,0 +1,23 @@
+# AGENTS.md — oz-agent-sdk (Ruby SDK for the Oz/Warp cloud agent platform)
+
+## Build & Test
+- Install: `bundle install`
+- Run all tests: `bundle exec rspec`
+- Run single test file: `bundle exec rspec spec/oz/resources/runs_spec.rb`
+- Run single example: `bundle exec rspec spec/oz/resources/runs_spec.rb:42`
+- Lint: `bundle exec rubocop` | Auto-fix: `bundle exec rubocop -A`
+- Full CI suite (lint + tests): `bundle exec rake ci`
+
+## Architecture
+- Gem entry: `lib/oz.rb` → top-level `Oz` module with global config & shared client
+- `Oz::Client` (`lib/oz/client.rb`) — Faraday-based HTTP client, configured via `Oz::Configuration`
+- Resources (`lib/oz/resources/`) — API resource classes (Runs, Schedules, Identities, Sessions, Conversations, Agent) inheriting from `Base`
+- `Oz::Model` — base model; `Oz::CursorPage` — paginated list wrapper; `Oz::Errors` — error hierarchy
+- Tests in `spec/` mirror `lib/` structure; use WebMock (no real HTTP), `build_client` helper, expect-only syntax
+
+## Code Style
+- Ruby >= 3.1; every file starts with `# frozen_string_literal: true`
+- RuboCop enforced: 120-char line limit, `Style/Documentation` disabled, no `Style/DoubleNegation`
+- Use `require_relative` for internal imports; `Oz::` namespace for all classes
+- RSpec: `expect` syntax only, `disable_monkey_patching!`, no real network calls (WebMock)
+- Env vars isolated per test via `around` hook (see `spec/spec_helper.rb`)

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-18
+
+### Added
+
+- Initial release of the Ruby SDK for the Oz API.
+- `Oz::Client` with Bearer authentication (`WARP_API_KEY`), configurable base URL
+  (`OZ_API_BASE_URL`), custom headers (`OZ_API_CUSTOM_HEADERS`), timeouts, and
+  automatic retries with exponential backoff for transient failures.
+- `client.agent` resource: `run`, `list`, `get_artifact`, `list_environments`.
+- `client.agent.runs`: `retrieve`, `list` (cursor pagination), `cancel`,
+  `list_handoff_attachments`, `submit_followup`.
+- `client.agent.schedules`: `create`, `retrieve`, `update`, `list`, `delete`,
+  `pause`, `resume`.
+- `client.agent.identities`: `create`, `update`, `list`, `retrieve`, `delete`.
+- `client.agent.sessions` and `client.agent.conversations`: `check_redirect`.
+- `Oz::CursorPage` with `auto_paging_each` for transparent multi-page iteration.
+- `Oz::Model` response wrapper with method/`[]` access and recursive nesting.
+- Typed error hierarchy mapping HTTP status codes to exception classes.
+
+[Unreleased]: https://github.com/warpdotdev/oz-sdk-ruby/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/warpdotdev/oz-sdk-ruby/releases/tag/v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing
+
+Thanks for your interest in improving the Oz Ruby SDK!
+
+## Development setup
+
+The Ruby toolchain is managed with [mise](https://mise.jdx.dev). The pinned default is
+**Ruby 4.0** (see [`mise.toml`](mise.toml)).
+
+```sh
+git clone https://github.com/warpdotdev/oz-sdk-ruby.git
+cd oz-sdk-ruby
+mise install        # install the pinned Ruby (4.0.x)
+make install        # bundle install
+```
+
+The gem supports Ruby 3.1+ (verified in CI across 3.1–4.0) and uses
+[Faraday](https://lostisland.github.io/faraday/) for HTTP.
+
+> **Bundler on Ruby 4:** use Bundler ≥ 2.7 (or 4.x). Bundler < 2.7 calls the removed
+> `CGI.parse` and aborts. If `bundle` fails, run `gem install bundler` to get a current one.
+
+## Common tasks
+
+All tasks are available through the `Makefile` (run `make help` to list them):
+
+| Command          | Description                                  |
+| ---------------- | -------------------------------------------- |
+| `make spec`      | Run the RSpec test suite                     |
+| `make lint`      | Run RuboCop                                  |
+| `make lint-fix`  | Run RuboCop with safe auto-correct           |
+| `make ci`        | Run lint + tests (what CI runs)              |
+| `make coverage`  | Run tests and open the coverage report       |
+| `make build`     | Build the gem into `pkg/`                     |
+| `make console`   | Open an IRB console with the gem loaded       |
+| `make docs`      | Generate YARD documentation                   |
+
+## Tests
+
+- Tests live in `spec/` and use RSpec + WebMock (no live network calls).
+- Please add coverage for any new behaviour; SimpleCov enforces a minimum.
+- Keep examples in `examples/` runnable.
+
+## Pull requests
+
+1. Create a feature branch off `main`.
+2. Make your change with tests and documentation.
+3. Ensure `make ci` passes locally.
+4. Open a PR describing the change and its motivation.
+
+## Releasing
+
+Maintainers publish releases by bumping the version and pushing a tag:
+
+```sh
+make tag VERSION=x.y.z   # bumps lib/oz/version.rb, commits, tags, pushes
+```
+
+Pushing a `v*` tag triggers the `Release Gem` GitHub Actions workflow, which runs
+the test suite and publishes to RubyGems (requires the `RUBYGEMS_API_KEY` secret).

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify gem's dependencies in oz-agent-sdk.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   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.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,64 @@
+.PHONY: setup install test spec lint lint-fix build release clean console docs coverage help tag ci
+
+help: ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}'
+
+setup: ## First-run setup: install the pinned Ruby (mise) + a current Bundler + deps
+	mise install
+	gem install bundler --no-document
+	bundle install
+
+install: ## Install dependencies
+	bundle install
+
+spec: ## Run RSpec tests
+	bundle exec rspec
+
+test: spec ## Alias for spec
+
+coverage: ## Run tests and open the coverage report
+	bundle exec rspec
+	open coverage/index.html
+
+lint: ## Run RuboCop linter
+	bundle exec rubocop
+
+lint-fix: ## Run RuboCop with safe auto-correct
+	bundle exec rubocop -A
+
+ci: ## Run the full CI suite locally (lint + tests)
+	bundle exec rake ci
+
+build: ## Build the gem into pkg/
+	bundle exec rake build
+
+docs: ## Generate YARD documentation into doc/
+	bundle exec yard doc
+
+console: ## Start an IRB console with the gem loaded
+	bundle exec irb -r oz
+
+clean: ## Remove build artifacts
+	rm -f *.gem
+	rm -rf pkg/ coverage/ doc/ .yardoc/
+
+release: tag ## Tag the current version and let CI publish to RubyGems
+	@echo "Pushed tag. The release workflow will publish to RubyGems."
+
+tag: ## Create and push a git tag for the current VERSION. Usage: make tag [VERSION=x.y.z]
+	@git fetch --tags; \
+	if [ -z "$(VERSION)" ]; then \
+		NEW_VERSION=$$(ruby -r ./lib/oz/version -e 'print Oz::VERSION'); \
+	else \
+		NEW_VERSION="$(VERSION)"; \
+		sed -i '' "s/VERSION = '.*'/VERSION = '$$NEW_VERSION'/" lib/oz/version.rb 2>/dev/null \
+			|| sed -i "s/VERSION = '.*'/VERSION = '$$NEW_VERSION'/" lib/oz/version.rb; \
+		git add lib/oz/version.rb; \
+		git commit -m "Release v$$NEW_VERSION" --allow-empty; \
+	fi; \
+	NEW_TAG="v$$NEW_VERSION"; \
+	echo "Tagging $$NEW_TAG ..."; \
+	git tag "$$NEW_TAG"; \
+	git push origin HEAD; \
+	git push origin "$$NEW_TAG"; \
+	echo "Done! Pushed $$NEW_TAG"

data/README.md

@@ -0,0 +1,266 @@
+# Oz Ruby SDK
+
+[![CI](https://github.com/warpdotdev/oz-sdk-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/warpdotdev/oz-sdk-ruby/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/oz-agent-sdk.svg)](https://rubygems.org/gems/oz-agent-sdk)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.1-CC342D.svg)](https://www.ruby-lang.org)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+The Oz Ruby SDK provides convenient access to the [Oz API](https://docs.warp.dev) — Warp's
+cloud agent platform — from any Ruby 3.1+ application. Run and manage cloud agents,
+schedules, agent identities, environments, and artifacts with an idiomatic, resource-oriented
+client.
+
+This is the Ruby counterpart to the official
+[Python](https://github.com/warpdotdev/oz-sdk-python) and
+[TypeScript](https://github.com/warpdotdev/oz-sdk-typescript) SDKs.
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'oz-agent-sdk'
+```
+
+Then run `bundle install`. Or install it directly:
+
+```sh
+gem install oz-agent-sdk
+```
+
+## Quick start
+
+```ruby
+require 'oz'
+
+client = Oz::Client.new(
+  api_key: ENV['WARP_API_KEY'] # the default; can be omitted if the env var is set
+)
+
+response = client.agent.run(prompt: 'Fix the bug in auth.rb')
+puts response.run_id
+puts response.state # => "QUEUED"
+```
+
+The API key is read from the `WARP_API_KEY` environment variable by default, so in most
+cases you can simply write `Oz::Client.new`.
+
+## Configuration
+
+Configure a single client instance, or set global defaults once at boot.
+
+```ruby
+# Per-client
+client = Oz::Client.new(
+  api_key: 'sk-...',
+  base_url: 'https://app.warp.dev/api/v1', # default; override with OZ_API_BASE_URL
+  timeout: 60,                              # seconds
+  max_retries: 2,                           # retries for transient failures
+  default_headers: { 'X-My-Header' => 'value' },
+  logger: Logger.new($stdout)               # optional Faraday request logging
+)
+
+# Global defaults + shared client
+Oz.configure do |config|
+  config.api_key = ENV.fetch('WARP_API_KEY')
+  config.max_retries = 3
+end
+
+Oz.client.agent.runs.list(limit: 20).each { |run| puts run.title }
+```
+
+### Environment variables
+
+| Variable                 | Description                                                        |
+| ------------------------ | ------------------------------------------------------------------ |
+| `WARP_API_KEY`           | Bearer token used to authenticate requests.                        |
+| `OZ_API_BASE_URL`        | Override the API base URL.                                         |
+| `OZ_API_CUSTOM_HEADERS`  | Extra headers, one `Key: Value` per line, added to every request. |
+
+## Usage with a custom configuration
+
+Pass a `config` hash to customise the run's environment, model, MCP servers, and more:
+
+```ruby
+response = client.agent.run(
+  prompt: 'Fix the bug in auth.rb',
+  config: {
+    environment_id: 'your-environment-id', # UID of a cloud environment
+    model_id: 'claude-sonnet-4',           # optional: specify the LLM model
+    name: 'bug-fix-config',                # optional: label for traceability
+    base_prompt: 'You are a helpful coding assistant.'
+  }
+)
+puts response.run_id
+```
+
+### MCP servers
+
+```ruby
+client.agent.run(
+  prompt: 'Check my GitHub issues',
+  config: {
+    environment_id: 'your-environment-id',
+    mcp_servers: {
+      github: { warp_id: 'your-shared-mcp-server-id' },
+      'custom-server' => {
+        command: 'npx',
+        args: ['-y', '@modelcontextprotocol/server-filesystem'],
+        env: { 'PATH' => '/usr/local/bin' }
+      },
+      'remote-server' => {
+        url: 'https://mcp.example.com/sse',
+        headers: { 'Authorization' => 'Bearer token' }
+      }
+    }
+  }
+)
+```
+
+## Resources
+
+The client mirrors the API's resource hierarchy under `client.agent`.
+
+### Runs
+
+```ruby
+client.agent.run(prompt: 'Refactor the parser')          # start a run
+run = client.agent.runs.retrieve('run-id')               # fetch one run
+client.agent.runs.cancel('run-id')                       # cancel a run
+client.agent.runs.submit_followup('run-id', message: 'continue', mode: 'plan')
+client.agent.runs.list_handoff_attachments('run-id')
+```
+
+#### Pagination
+
+`runs.list` returns an `Oz::CursorPage`. Iterate one page, or transparently walk all pages
+with `auto_paging_each`:
+
+```ruby
+page = client.agent.runs.list(limit: 50, state: %w[INPROGRESS QUEUED])
+page.each { |run| puts run.run_id }      # this page only
+
+client.agent.runs.list(limit: 50).auto_paging_each do |run|
+  puts run.title                         # every run across all pages
+end
+```
+
+### Schedules
+
+```ruby
+schedule = client.agent.schedules.create(
+  cron_schedule: '0 9 * * *',
+  name: 'nightly-dependency-check',
+  prompt: 'Check for outdated dependencies and open a PR'
+)
+
+client.agent.schedules.list
+client.agent.schedules.retrieve(schedule.schedule_id)
+client.agent.schedules.update(schedule.schedule_id, enabled: false)
+client.agent.schedules.pause(schedule.schedule_id)
+client.agent.schedules.resume(schedule.schedule_id)
+client.agent.schedules.delete(schedule.schedule_id)
+```
+
+### Agent identities
+
+```ruby
+identity = client.agent.identities.create(name: 'ci-bot', description: 'CI agent')
+client.agent.identities.list
+client.agent.identities.retrieve(identity.uid)
+client.agent.identities.update(identity.uid, description: 'Updated')
+client.agent.identities.delete(identity.uid)
+```
+
+### Agents, environments, and artifacts
+
+```ruby
+client.agent.list(sort_by: 'last_run')          # available agents (skills)
+client.agent.list_environments                   # cloud environments
+client.agent.get_artifact('artifact-uid')        # a plan / screenshot / file artifact
+```
+
+### Sessions and conversations
+
+```ruby
+client.agent.sessions.check_redirect('session-uuid')
+client.agent.conversations.check_redirect('conversation-id')
+```
+
+## Responses
+
+Responses are wrapped in `Oz::Model`, which exposes fields as methods and via `[]`, and
+wraps nested objects/arrays recursively. Unknown/optional fields return `nil`.
+
+```ruby
+run = client.agent.runs.retrieve('run-id')
+run.state                 # => "SUCCEEDED"
+run['run_id']             # => "run-id"
+run.is_sandbox_running?   # predicate form for booleans
+run.agent_config.model_id # nested access
+run.to_h                  # plain Hash with string keys
+```
+
+## Error handling
+
+Every API failure raises a subclass of `Oz::APIError`, carrying the HTTP status, the parsed
+response body, a machine-readable `code`, and the `request_id`.
+
+```ruby
+begin
+  client.agent.run(prompt: 'do the thing')
+rescue Oz::RateLimitError => e
+  retry_after(e)
+rescue Oz::AuthenticationError
+  warn 'Check your WARP_API_KEY'
+rescue Oz::APIStatusError => e
+  warn "API error #{e.status_code} (#{e.code}): #{e.message}"
+rescue Oz::APIConnectionError => e
+  warn "Network problem: #{e.message}"
+end
+```
+
+| Exception                     | When                                |
+| ----------------------------- | ----------------------------------- |
+| `Oz::BadRequestError`         | HTTP 400                            |
+| `Oz::AuthenticationError`     | HTTP 401 / missing API key          |
+| `Oz::PermissionDeniedError`   | HTTP 403                            |
+| `Oz::NotFoundError`           | HTTP 404                            |
+| `Oz::ConflictError`           | HTTP 409                            |
+| `Oz::UnprocessableEntityError`| HTTP 422                            |
+| `Oz::RateLimitError`          | HTTP 429                            |
+| `Oz::InternalServerError`     | HTTP 5xx                            |
+| `Oz::APIConnectionError`      | Connection failure                  |
+| `Oz::APITimeoutError`         | Request timeout                     |
+
+All inherit from `Oz::APIError < Oz::Error < StandardError`.
+
+### Retries
+
+Connection errors, timeouts, and HTTP `408`, `409`, `429`, and `5xx` responses are retried
+automatically (default: 2 retries) with exponential backoff and jitter. A numeric
+`Retry-After` header is honoured. Tune it with `max_retries:` (set to `0` to disable).
+
+## Development
+
+This project uses [mise](https://mise.jdx.dev) to manage the Ruby toolchain. The default
+version is **Ruby 4.0** (pinned in [`mise.toml`](mise.toml)); the gem itself supports Ruby
+3.1+.
+
+```sh
+make setup     # mise install + current Bundler + bundle install (run once)
+make spec      # run tests
+make lint      # run RuboCop
+make ci        # lint + tests (what CI runs)
+make build     # build the gem
+make help      # list all tasks
+```
+
+> On Ruby 4, use Bundler ≥ 2.7 (or 4.x). Bundler < 2.7 calls the removed `CGI.parse` and
+> will fail — `make setup` installs a compatible one for you.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more, and [`docs/`](docs/) for deeper guides.
+
+## License
+
+Released under the [Apache-2.0](LICENSE) license.