context_readers.progress
What it does
Record an attributed coverage assertion or heartbeat. A heartbeat never clears gaps or refreshes coverage. Provider cursors stay local.
Before you send it
An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe context_readers.progress through GET /v1/catalog/commands/{name} before acting.
This command does not accept source_document_id in its envelope. Any input evidence requirements remain as documented below.
Inputs
Put these fields inside the envelope’s input object. The outer envelope names the command, a stable idempotency_key and effective_at; request and recovery rules explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.
Required means required within its containing object; an optional parent can be omitted.
| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
readerId | string | Yes | Minimum length: 1. Maximum length: 512. Example: "reader_example". |
expectedRevision | integer | Yes | Minimum: 1. Example: 2. |
phase | string | Yes | Choose "idle", "catching_up", "recovering", "failed", "paused". Example: "idle". |
checkpointDigest | string | Yes | Pattern: "^(sha256|blake3):[a-f0-9]{64}$". Example: "sha256:0000000000000000000000000000000000000000000000000000000000000000". |
observedThrough | string | No | Minimum length: 1. Maximum length: 40. Example: "2026-11-15T12:00:00.000Z". |
gapStart | schema-defined | No | Choose a matching alternative in the exact schema below. |
gapReason | string | No | Choose "authorization_lost", "cursor_expired", "rate_limited", "provider_unavailable", "import_denied", "storage_limit", "runner_error", "initial_sync", "incomplete_provider_coverage". |
errorCode | string | No | Choose "authorization_lost", "cursor_expired", "rate_limited", "provider_unavailable", "import_denied", "storage_limit", "runner_error". |
After acceptance
When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns commandId, replayed, the command-specific result below and emitted events with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.
Inspect result and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch GET /v1/commands/{id} with commandId to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with events: [] and return a transient result and commandId without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain no_change is a separate success outcome with no persisted receipt.
Result fields
Required means required within its containing object; an optional parent can be omitted.
| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
readerId | string | Yes | Minimum length: 1. Maximum length: 512. |
revision | integer | Yes | Minimum: 1. |
recordedAt | string | Yes | Minimum length: 1. Maximum length: 40. |
health | string | Yes | Choose "disabled", "initial_sync", "healthy", "catching_up", "stale", "failed", "partial". |
All commands · Operation and errors · Reusable schemas
Keep credentials out of prompts; rehearse writes only in a disposable sandbox.
Exact request schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"const": "context_readers.progress"
},
"input": {
"type": "object",
"properties": {
"readerId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"expectedRevision": {
"type": "integer",
"minimum": 1
},
"phase": {
"enum": [
"idle",
"catching_up",
"recovering",
"failed",
"paused"
]
},
"checkpointDigest": {
"type": "string",
"pattern": "^(sha256|blake3):[a-f0-9]{64}$"
},
"observedThrough": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"gapStart": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 40
},
{
"type": "null"
}
]
},
"gapReason": {
"enum": [
"authorization_lost",
"cursor_expired",
"rate_limited",
"provider_unavailable",
"import_denied",
"storage_limit",
"runner_error",
"initial_sync",
"incomplete_provider_coverage"
]
},
"errorCode": {
"enum": [
"authorization_lost",
"cursor_expired",
"rate_limited",
"provider_unavailable",
"import_denied",
"storage_limit",
"runner_error"
]
}
},
"required": [
"readerId",
"expectedRevision",
"phase",
"checkpointDigest"
],
"additionalProperties": false
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "A key you choose, stable for this one command: retrying with it returns the original receipt instead of running again; reusing it for a different command is refused."
},
"effective_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the change takes effect in the books, in UTC with Z: the business date it happened, not when you record it."
}
},
"required": [
"name",
"input",
"idempotency_key",
"effective_at"
],
"additionalProperties": false
}Accepted command receipt
{
"type": "object",
"required": [
"commandId",
"replayed",
"result",
"events"
],
"properties": {
"commandId": {
"type": "string"
},
"replayed": {
"type": "boolean"
},
"imported": {
"const": true,
"description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
},
"result": {
"type": "object",
"properties": {
"readerId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"revision": {
"type": "integer",
"minimum": 1
},
"recordedAt": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"health": {
"enum": [
"disabled",
"initial_sync",
"healthy",
"catching_up",
"stale",
"failed",
"partial"
]
}
},
"required": [
"readerId",
"revision",
"recordedAt",
"health"
],
"additionalProperties": false
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"cid": {
"type": "string"
}
}
}
}
}
}Example request
{
"name": "context_readers.progress",
"input": {
"readerId": "reader_example",
"expectedRevision": 2,
"phase": "idle",
"checkpointDigest": "sha256:0000000000000000000000000000000000000000000000000000000000000000",
"observedThrough": "2026-11-15T12:00:00.000Z"
},
"effective_at": "2026-09-01T00:00:00Z",
"idempotency_key": "context_readers.progress-example-0"
}