Create pending elicitation
Stores a pending approval request from the runtime.
Request body
{
"executionId": "abc-123",
"toolPath": "github.issues.create",
"message": "Create issue \"Fix login bug\" in my-org/my-repo?",
"args": { "owner": "my-org", "repo": "my-repo", "title": "Fix login bug" },
"type": "approval"
}
ElicitationRequestSchema:
| Field | Type | Required | Default | Description |
|---|
executionId | string | Yes | — | Unique execution ID |
toolPath | string | Yes | — | Tool requesting approval |
message | string | Yes | — | Human-readable description of the action |
args | object | No | — | Arguments to the tool |
type | string | No | "approval" | "approval" or "form" |
Response (201)
{
"stored": true,
"executionId": "abc-123"
}
Poll elicitation status
Check whether a pending elicitation has been resolved.
| Parameter | In | Required | Description |
|---|
id | path | Yes | Execution ID |
{
"executionId": "abc-123",
"status": "pending"
}
The poll endpoint returns a status string. Once resolved via the resolve endpoint below, the response shape changes to use the ElicitationResponseSchema which has an approved boolean field instead of a status string.
Resolve elicitation
POST /api/elicitation/:id/resolve
| Parameter | In | Required | Description |
|---|
id | path | Yes | Execution ID |
Request body
{
"approved": true,
"data": {}
}
ElicitationResponseSchema:
| Field | Type | Required | Description |
|---|
approved | boolean | Yes | Whether to approve the action |
data | object | No | Additional form data (for type: "form" elicitations) |
Response (200)
{
"executionId": "abc-123",
"approved": true,
"resolved": true
}
