Skip to content

docs: update promptDelivery to synchronous after async revert (#3274) #3277

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
aegis-gh-agent merged 1 commit into from
May 13, 2026
Merged

docs: update promptDelivery to synchronous after async revert (#3274) #3277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions docs/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,7 +763,7 @@ curl -X POST http://localhost:9100/v1/sessions \
"workDir": "/home/user/my-project",
"status": "working",
"createdAt": 1712650800000,
"promptDelivery": { "delivered": false, "attempts": 0, "status": "pending" }
"promptDelivery": { "delivered": true, "attempts": 1, "status": "delivered" }
}
```

Expand All @@ -773,11 +773,9 @@ curl -X POST http://localhost:9100/v1/sessions \
|-------|------|-------------|
| `delivered` | boolean | Whether the prompt was successfully delivered to the agent |
| `attempts` | number | Number of delivery attempts |
| `status` | string | Delivery status: `pending` (ACP async, not yet sent), `delivered`, `failed`, or `timeout` |
| `status` | string | Delivery status: `delivered` or `failed` |

> **Async delivery (ACP):** For ACP sessions with a prompt, the server returns `201` immediately with `status: "pending"`. The prompt is delivered in the background. Poll `GET /v1/sessions/:id` to check `promptDelivery.status` until it transitions to `delivered` or `failed`.
>
> **Non-ACP sessions:** For built-in sessions, `promptDelivery` is resolved synchronously — `status` is omitted and `delivered` reflects the immediate result.
> **Synchronous delivery:** The server blocks until the agent acknowledges the prompt. `promptDelivery.status` is `delivered` or `failed` immediately in the response — no polling needed.
>
> **ACP disabled:** When ACP is disabled, `delivered` is `false` with no agent process spawned. The response includes a `warning` field. Enable via `AEGIS_ACP_ENABLED=true` or `"acpEnabled": true` in config.

Expand Down
Loading