Skip to content

Commit c5038af

Browse files
author
Hermes
committed
docs(api): update /send 422 error docs for #4812 prompt-ack-timeout semantics
PR #4812 reverses the #4705 assumption: a session/prompt timeout is now treated as delivered:true (slow ack on a live pipe, not non-delivery). Update the error-values note in the POST /v1/sessions/:id/send section to reflect the new semantics and clarify when prompt_ack_timeout still surfaces in the 422 response. Refs: #4812, #4705
1 parent 4b28fbd commit c5038af

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/api-reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1721,7 +1721,9 @@ Returned in two cases with the same response shape:
17211721
}
17221722
```
17231723

1724-
> **Error values:** `message` may be `prompt_ack_timeout` (ACP runtime did not acknowledge within the timeout), `no_active_transport` (session has no active ACP transport), a JSON-RPC error code (e.g. `-32601 Method not found`), or another backend-specific error string. `attempts` is the number of delivery attempts the backend made before giving up.
1724+
> **Error values:** `message` may be `prompt_ack_timeout` (ACP runtime acknowledged slowly — the prompt was still written to the live JSON-RPC pipe and processed; the ack merely lagged past the 5 s window on idle or cold-resumed sessions), `no_active_transport` (session has no active ACP transport), a JSON-RPC error code (e.g. `-32601 Method not found`), or another backend-specific error string. `attempts` is the number of delivery attempts the backend made before giving up.
1725+
1726+
> **Note on `prompt_ack_timeout`:** As of PR #4812, a timeout on `session/prompt` is treated as `delivered: true` at the backend level — the request is written to a live pipe and claude-agent-acp processes it in order. The 422 response with `prompt_ack_timeout` only surfaces when the runtime itself reports `delivered: false` (e.g., a genuine transport failure or a dead pipe). The transcript remains the source of truth for whether the prompt was actually processed.
17251727
17261728
**Errors:**
17271729

0 commit comments

Comments
 (0)