docs: cover get_workflow, asset deletion, and job_id in the README

[wei-hai]

comfy-sdk 0.1.8 shipped three capabilities the README never mentions. A stale reference doc in a published package is worse than a missing one.

Added

• Getting a job's workflow back — get_workflow() on both clients, the format discriminator (api vs save), and why this is the only way to see the graph behind a job rehydrated by id. It states plainly that submissions from this SDK always get api today, since v2 has no version-pinning fields yet.
• Asset deletion — asset.delete() and client.assets.delete(id), noting it needs a proxy new enough to serve DELETE /api/v2/assets/{id}; older ones return 405.
• job_id and expires_at — on assets and outputs, including that job_id is None for an uploaded asset, which has no producing job.

How it was checked

Every claim was read against the source behind it, not the changelog. The runnable parts were executed against the installed package — including confirming the pre-COMFY_BASE_URL positional call really does raise TypeError, since a sibling doc shipped examples that didn't.

The rest of the README was audited at the same time and found accurate: install requirements against pyproject.toml, the COMFY_BASE_URL and keyword-only api_key behaviour, the partner-node key distinction, client_info/User-Agent, the typed-exception list against exceptions.py's map (exact match), the two-layer architecture description, and the release commands against CI.

pytest 140 passed / 4 skipped; ruff, ruff format, mypy, and the public-repo hygiene check all clean.

Two things found but deliberately not changed

• Job.cancel() and Job.refresh() have no README mention. Not stale, just absent, and the README already omits other real methods. Worth a decision on whether this doc aims at full method coverage.
• AsyncOutput has no to_stream(), while Output does. That's a code asymmetry rather than a doc bug, so it stayed out of a docs-only change — but it makes the docs-site claim that the sync and async clients have "the same surface" untrue by exactly one method. Filed here so it isn't lost.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added guidance for asset metadata, expiration details, and deletion options.
  • Documented compatibility with proxies and asynchronous asset operations.
  • Added instructions for retrieving job workflows and using supported workflow formats.
  • Explained how output handles identify the job that produced them.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1678c528-dca4-49ff-89a7-38ddfee58889

📥 Commits

Reviewing files that changed from the base of the PR and between 86839a0 and b5f9925.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README adds documentation for asset metadata, asset deletion, workflow retrieval formats, asynchronous equivalents, and output handle job_id values.

Changes

SDK documentation

Layer / File(s)	Summary
Asset metadata and deletion README.md	Documents committed asset metadata, handle-based and ID-based deletion, the required proxy endpoint, and asynchronous deletion equivalents.
Job workflows and output handles README.md	Documents get_workflow() retrieval, "api" and "save" formats, asynchronous retrieval, and output handle job_id values.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Mergeability Score: ⚪ Minimal · up to b5f99

This localized documentation update adds coverage for existing SDK behavior without changing runtime code or production behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: alexisrolland

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely identifies the three main README documentation changes: get_workflow, asset deletion, and job_id.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch wei/readme-v2-surface

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}