From 734d544244497356d8abf2fb1686cb9c80a289d0 Mon Sep 17 00:00:00 2001 From: seemeroland Date: Mon, 8 Jun 2026 17:18:20 +0000 Subject: [PATCH 1/3] docs(api): surface the run followups endpoint in API & SDK reference The POST /agent/runs/{runId}/followups endpoint is available in the REST API and the generated SDKs (runs.submit_followup), but the API & SDK overview page only listed run/list/get as primary endpoints, so it was hard to discover. Add the follow-up (and cancel) endpoints to the Key Endpoints list, add RunFollowupRequest to the models list, and add a next-steps pointer in the quickstart. REMOTE-1889 Co-Authored-By: Oz --- src/content/docs/reference/api-and-sdk/index.mdx | 11 +++++++++-- src/content/docs/reference/api-and-sdk/quickstart.mdx | 1 + 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/content/docs/reference/api-and-sdk/index.mdx b/src/content/docs/reference/api-and-sdk/index.mdx index 64c09666..2d150990 100644 --- a/src/content/docs/reference/api-and-sdk/index.mdx +++ b/src/content/docs/reference/api-and-sdk/index.mdx @@ -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` @@ -104,8 +104,14 @@ 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` -All endpoint semantics, query parameters, and [error codes](/reference/api-and-sdk/troubleshooting/errors/) are documented on the [Agents API Reference](/api). + 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 query `mode` 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. + +The follow-up and cancel endpoints are also available in the SDKs (for example, `runs.submit_followup` and `runs.cancel`). All endpoint semantics, query parameters, and [error codes](/reference/api-and-sdk/troubleshooting/errors/) are documented on the [Agents API Reference](/api). --- @@ -122,6 +128,7 @@ The API shares a set of reusable models across endpoints. Detailed JSON schemas, * `RunCreatorInfo` * `RunState` * `RunSourceType` +* `RunFollowupRequest` * `AmbientAgentConfig` * `MCPServerConfig` * `Error` diff --git a/src/content/docs/reference/api-and-sdk/quickstart.mdx b/src/content/docs/reference/api-and-sdk/quickstart.mdx index 547b26ff..33e00fcd 100644 --- a/src/content/docs/reference/api-and-sdk/quickstart.mdx +++ b/src/content/docs/reference/api-and-sdk/quickstart.mdx @@ -91,6 +91,7 @@ You can also view and manage all runs in the [Oz dashboard](https://oz.warp.dev/ ## Next steps +* **Send a follow-up to a run** - Use `POST /agent/runs/{runId}/followups` (or `runs.submit_followup` in the SDKs) to send a follow-up message to a run, the same way the Slack and Linear integrations continue a run. The server routes the message based on the run's current state. See the [Oz API reference](/reference/api-and-sdk/) and the [Agents API Reference](/api). * **Read the full API reference** - [Oz API](/reference/api-and-sdk/) documents all endpoint parameters, query filters, and response schemas. * **Explore the SDKs** - [Python SDK](https://github.com/warpdotdev/oz-sdk-python) and [TypeScript SDK](https://github.com/warpdotdev/oz-sdk-typescript) include typed request/response models, retries, and error handling. * **See a real-world example** - [Demo: Sentry monitoring with SDK](/reference/api-and-sdk/demo-sentry-monitoring-with-sdk/) shows how to build a webhook handler that triggers agents from production errors. From 4bc87bd533f3dbd91ad3d42316b51620bebfb949 Mon Sep 17 00:00:00 2001 From: hongyi-chen Date: Tue, 9 Jun 2026 18:51:23 +0000 Subject: [PATCH 2/3] docs(api): align follow-ups endpoint copy with other endpoints Trim the follow-ups entry in the Key endpoints list to a single concise line matching the other endpoint descriptions, drop the SDK sentence that singled out follow-ups and cancel, and remove the follow-up bullet from the quickstart Next steps. Co-Authored-By: Oz --- src/content/docs/reference/api-and-sdk/index.mdx | 4 ++-- src/content/docs/reference/api-and-sdk/quickstart.mdx | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/src/content/docs/reference/api-and-sdk/index.mdx b/src/content/docs/reference/api-and-sdk/index.mdx index 1067512e..aae5562f 100644 --- a/src/content/docs/reference/api-and-sdk/index.mdx +++ b/src/content/docs/reference/api-and-sdk/index.mdx @@ -106,12 +106,12 @@ See the [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) or [**Type 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, 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 query `mode` are described by the `RunFollowupRequest` model. + Send a follow-up message to an existing run to steer or continue it, the same way the Slack and Linear integrations do. * `POST /agent/runs/{runId}/cancel` Cancel a run that is currently queued or in progress. Returns the ID of the cancelled run. -The follow-up and cancel endpoints are also available in the SDKs (for example, `runs.submit_followup` and `runs.cancel`). All endpoint semantics, query parameters, and [error codes](/reference/api-and-sdk/troubleshooting/errors/) are documented on the [Agents API Reference](/api). +All endpoint semantics, query parameters, and [error codes](/reference/api-and-sdk/troubleshooting/errors/) are documented on the [Agents API Reference](/api). --- diff --git a/src/content/docs/reference/api-and-sdk/quickstart.mdx b/src/content/docs/reference/api-and-sdk/quickstart.mdx index 33e00fcd..547b26ff 100644 --- a/src/content/docs/reference/api-and-sdk/quickstart.mdx +++ b/src/content/docs/reference/api-and-sdk/quickstart.mdx @@ -91,7 +91,6 @@ You can also view and manage all runs in the [Oz dashboard](https://oz.warp.dev/ ## Next steps -* **Send a follow-up to a run** - Use `POST /agent/runs/{runId}/followups` (or `runs.submit_followup` in the SDKs) to send a follow-up message to a run, the same way the Slack and Linear integrations continue a run. The server routes the message based on the run's current state. See the [Oz API reference](/reference/api-and-sdk/) and the [Agents API Reference](/api). * **Read the full API reference** - [Oz API](/reference/api-and-sdk/) documents all endpoint parameters, query filters, and response schemas. * **Explore the SDKs** - [Python SDK](https://github.com/warpdotdev/oz-sdk-python) and [TypeScript SDK](https://github.com/warpdotdev/oz-sdk-typescript) include typed request/response models, retries, and error handling. * **See a real-world example** - [Demo: Sentry monitoring with SDK](/reference/api-and-sdk/demo-sentry-monitoring-with-sdk/) shows how to build a webhook handler that triggers agents from production errors. From 50f88fb9a4f75e454e1b79620b96f91996f035da Mon Sep 17 00:00:00 2001 From: hongyi-chen Date: Tue, 9 Jun 2026 18:53:24 +0000 Subject: [PATCH 3/3] docs(api): tighten follow-ups endpoint wording Co-Authored-By: Oz --- src/content/docs/reference/api-and-sdk/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/reference/api-and-sdk/index.mdx b/src/content/docs/reference/api-and-sdk/index.mdx index aae5562f..12706836 100644 --- a/src/content/docs/reference/api-and-sdk/index.mdx +++ b/src/content/docs/reference/api-and-sdk/index.mdx @@ -106,7 +106,7 @@ See the [**Python SDK**](https://github.com/warpdotdev/oz-sdk-python) or [**Type 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 way the Slack and Linear integrations do. + Send a follow-up message to an existing run to steer or continue it, the same capability the Slack and Linear integrations use. * `POST /agent/runs/{runId}/cancel` Cancel a run that is currently queued or in progress. Returns the ID of the cancelled run.