Skip to content

docs: fix stale warp_sdk import in README usage example#33

Draft
kjankov wants to merge 1 commit into
mainfrom
oz/fix-readme-stale-import
Draft

docs: fix stale warp_sdk import in README usage example#33
kjankov wants to merge 1 commit into
mainfrom
oz/fix-readme-stale-import

Conversation

@kjankov

@kjankov kjankov commented Jun 18, 2026

Copy link
Copy Markdown

Summary

Fixes a stale import example in the "Using environments and configuration" section of README.md.

The original code block incorrectly referenced a non-existent warp_sdk package and WarpAPI class, and used response.task_id which doesn't match the actual API response shape. This PR updates the example to match all other usage examples in the README.

Changes

Before:

from warp_sdk import WarpAPI

client = WarpAPI()
...
print(response.task_id)

After:

import os
from oz_agent_sdk import OzAPI

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

Testing

  • ruff check . — all checks passed (no Python code changed, only README.md)
  • Change is documentation-only; no runtime behavior affected.

Screenshot

README diff showing the fix

Conversation: http://localhost:8080/conversation/52a1560c-ce51-4ce7-80bc-94edbc640e92
Run: http://localhost:8082/runs/019edc91-9c43-7ba0-b979-89eaac961ffb

This PR was generated with Oz.

Replace outdated 'from warp_sdk import WarpAPI' with correct
'from oz_agent_sdk import OzAPI', update client instantiation to
match the pattern used throughout the rest of the README, and fix
response attribute from task_id to run_id.

Co-Authored-By: Oz <oz-agent@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant