Skip to main content
POST
Explicitly prepare or retry a Canvas round

Authorizations

Authorization
string
header
required

API key authentication. Pass your key as a Bearer token. Keys use the format hm_live_<32 hex chars>. Generate keys from your Harmonica dashboard settings.

Path Parameters

instanceId
string
required

Existing BMC chain instance ID; each chain has its own Canvas.

Minimum string length: 1

Body

application/json
stepIndex
integer
required
Required range: x >= 0
retry
boolean

Must be explicitly true for an authenticated editor request, including first preparation. Missing or false returns explicit_retry_required.

Response

Existing claim status or completed preparation; revision is present only after a claimed extraction finishes.

status
enum<string>
required
Available options:
pending,
ready,
error
revision
integer

Current revision number after a claimed extraction finishes; omitted for an unchanged existing claim. Ready does not mean human approval.

Required range: x >= 0