Append an agent-reported Fulfillment status for an exact approved proposal.
POST /api/v1/interactions/{interactionId}/fulfillment
Requires ownership or explicit fulfillment authority, exact Decision/revision/action/fingerprint binding, and Idempotency-Key. Later reports correct history without rewriting it.
Access
Section titled “Access”Use a credential with commentary.interactions.fulfillment.
Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.
Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
interactionId |
path | string | Yes | Opaque Interaction id. |
Idempotency-Key |
header | string | Yes | |
X-Correlation-Id |
header | string | No | |
X-Commentary-Workspace-Id |
header | string | No | Must match the credential workspace. This header cannot widen grant authority. |
Request body
Section titled “Request body”Required. Supported content types: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
decisionId |
string | Yes | |
revisionId |
string | Yes | |
actionId |
string | Yes | |
proposalFingerprint |
string | Yes | |
status |
"received" · "started" · "completed" · "failed" · "unknown" |
Yes | |
evidence |
object or null | No | Sanitized JSON evidence, at most 8 KiB; credentials and raw logs are forbidden. |
Call the endpoint
Section titled “Call the endpoint”Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.
curl --request POST \ 'https://commentary.dev/api/v1/interactions/<interactionId>/fulfillment' \ --header 'Authorization: Bearer <your-token>' \ --header 'Content-Type: application/json' \ --data-binary @request.jsonResponses
Section titled “Responses”| Status | Meaning | Payload |
|---|---|---|
200 |
Successful response. | object |
201 |
Successful response. | object |
400 |
The request was invalid. | ExternalError |
401 |
Authentication is required. | ExternalError |
403 |
The token or session does not have permission for this resource. | ExternalError |
404 |
The resource was not found. | ExternalError |
409 |
Approval, fingerprint, lifecycle, expiry, or idempotency conflict. | InteractionApiError |
410 |
Interaction content was purged. | InteractionApiError |
429 |
The request was rate limited. | ExternalError |
Successful response fields
Section titled “Successful response fields”Value type: object.
Recover from errors
Section titled “Recover from errors”Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.
Contract and related guidance
Section titled “Contract and related guidance”Operation ID: reportInteractionFulfillment. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.