Submit a dry-run-passed proposal for HITL review
const url = 'https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/submit-review';const options = { method: 'POST', headers: { 'X-Supervisor-Id': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"requiredRole":"standard","expiresAt":"2026-04-15T12:00:00Z"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/submit-review \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Supervisor-Id: example' \ --data '{ "requiredRole": "standard", "expiresAt": "2026-04-15T12:00:00Z" }'Enqueues a HITL approval and transitions the proposal to proposed-for-review. Legal only from dry-run-passed. Body is optional; defaults auto-derive the reviewer role (meta-fixes → senior).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”FixProposalId — opaque branded string (a UUID).
Header Parameters
Section titled “Header Parameters”SupervisorId scoping this request. Every /v1/proposals route requires this header — proposals are supervisor-owned, and the API does not derive supervisor scope from the token.
Caller-supplied idempotency key. Retries with the same key return the original response byte-identical (per docs/API-ROUTE-CONVENTIONS.md §3.1).
Request Body
Section titled “Request Body”Body is optional — omit to accept every default. requiredRole overrides the auto-derivation (meta-fixes → senior). expiresAt sets the HITL approval deadline.
object
Reviewer role class. Hierarchy: standard < senior < admin.
Responses
Section titled “Responses”Review enqueued.
object
object
FixProposalId.
Semver of the baseline agent version.
Polymorphic change payload. Shape depends on the sibling tier on the proposal (prompt / retrieval / tool-config).
object
object
Sha256(tier + agentId + agentVersion + canonical(change)). Dedup key.
HITL approval id created when the proposal was submitted for review.
Semver of the new agent version the proposal materialized as. Present on applied and rolled-back proposals.
True when the proposal targets one of the supervisor’s own agent ids — reviewer role auto-bumps to senior unless overridden.
Example
{ "proposal": { "tier": "prompt", "patternRefs": [ { "kind": "guardrail-violation" } ], "status": "draft" }}Malformed request body.
object
object
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
Optional, kind-specific.
object
Server-assigned request id; also echoed via X-Request-Id header.
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}Missing / malformed / expired / revoked bearer token.
object
object
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
Optional, kind-specific.
object
Server-assigned request id; also echoed via X-Request-Id header.
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}No proposal visible under this supervisor with that id.
object
object
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
Optional, kind-specific.
object
Server-assigned request id; also echoed via X-Request-Id header.
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}Idempotency-Key was reused with a different body, or resource-state conflict.
object
object
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
Optional, kind-specific.
object
Server-assigned request id; also echoed via X-Request-Id header.
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}Ground-layer guardrail violation.
object
object
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
Optional, kind-specific.
object
Server-assigned request id; also echoed via X-Request-Id header.
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}Server error (unmapped domain code or framework crash).
object
object
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
Optional, kind-specific.
object
Server-assigned request id; also echoed via X-Request-Id header.
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}