Skip to content

docs(api): surface the run followups endpoint in API & SDK reference #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hongyi-chen merged 4 commits into from
Jun 9, 2026
+8 −1
Merged

docs(api): surface the run followups endpoint in API & SDK reference #190

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
734d544
docs(api): surface the run followups endpoint in API & SDK reference
seemeroland Jun 8, 2026
a0b3616
Merge branch 'main' into oz-agent/REMOTE-1889-surface-followups-api-sdk
hongyi-chen Jun 9, 2026
4bc87bd
docs(api): align follow-ups endpoint copy with other endpoints
hongyi-chen Jun 9, 2026
50f88fb
docs(api): tighten follow-ups endpoint wording
hongyi-chen Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/content/docs/reference/api-and-sdk/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ See the [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) or [**Type

### Key endpoints

**The Agents API exposes three primary endpoints:**
**The Agents API exposes these primary endpoints:**

* `POST /agent/run`

Expand All @@ -104,6 +104,12 @@ See the [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) or [**Type
* `GET /agent/runs/{runId}`

Fetch full details for a single run, including session link and resolved configuration.
* `POST /agent/runs/{runId}/followups`

Send a follow-up message to an existing run to steer or continue it, the same capability the Slack and Linear integrations use.

@oz-for-oss oz-for-oss Bot Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 [SUGGESTION] Avoid calling mode an "optional query" here; RunFollowupRequest defines it as a request-body field, and this wording can read like a URL query parameter.

Suggested change
Send a follow-up message to an existing run to steer or continue it, the same capability the Slack and Linear integrations use.
Send a follow-up message to an existing run, the same capability the Slack and Linear integrations use to continue a run. The server routes the message based on the run's current state (queued, running, or ended), so you can steer or continue a run programmatically. A `200` response means the follow-up was accepted; observe the updated state with `GET /agent/runs/{runId}`. The follow-up message and optional `mode` field are described by the `RunFollowupRequest` model.

* `POST /agent/runs/{runId}/cancel`

Cancel a run that is currently queued or in progress. Returns the ID of the cancelled run.

All endpoint semantics, query parameters, and [error codes](/reference/api-and-sdk/troubleshooting/errors/) are documented on the [Agents API Reference](/api).

Expand All @@ -122,6 +128,7 @@ The API shares a set of reusable models across endpoints. Detailed JSON schemas,
* `RunCreatorInfo`
* `RunState`
* `RunSourceType`
* `RunFollowupRequest`
* `AmbientAgentConfig`
* `MCPServerConfig`
* `Error`
Expand Down
Loading