Human-in-the-Loop
GET /api/orgs/{org_id}/hitl-requests
Section titled “GET /api/orgs/{org_id}/hitl-requests”List Hitl Requests
List an organization’s HITL requests, newest first.
Defaults to pending — the questions still waiting on a human. Pass
status to read the history instead. The value is typed, so FastAPI
rejects anything outside :data:HitlStatus with a 422 before the handler
runs; a filter this endpoint cannot honour is never silently dropped.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| limit | query | integer | no | |
| offset | query | integer | no | |
| org_id | path | string (uuid) | yes | |
| status | query | "pending" | "approved" | "rejected" | "responded" | "cancelled" | "expired" | no | Return only requests with this status. Omit for the pending inbox (the default). An unrecognised value is rejected with 422 rather than quietly falling back to pending. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | HitlListResponse |
| 422 | Validation Error | HTTPValidationError |
GET /api/orgs/{org_id}/hitl-requests/{request_id}
Section titled “GET /api/orgs/{org_id}/hitl-requests/{request_id}”Get Hitl Request
Get a single HITL request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| request_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | HitlRequestResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/hitl-requests/{request_id}/respond
Section titled “POST /api/orgs/{org_id}/hitl-requests/{request_id}/respond”Respond To Hitl Request
Respond to a pending HITL request and resume the chat.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| request_id | path | string (uuid) | yes |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
| action | string | no | |
| selection | string | no | |
| selections | object | no | |
| text | string | no |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | HitlRequestResponse |
| 422 | Validation Error | HTTPValidationError |