Coordinator API
The miner-facing CoreTex API exposes dynamic mining context, public corpus
research data, substrate reads, structural dryrun, submission, and receipt
recovery. Static protocol overview lives in docs; live authoring values come
from /coretex/status and /coretex/schema.
| Method | Path | Purpose |
|---|---|---|
GET |
/coretex/health |
Coordinator health, epoch, chain, pins, finality lag, and accepting status |
GET |
/coretex/status?miner=0x... |
Dynamic miner context, current root, patch policy, thresholds, counters, and active surfaces |
GET |
/coretex/schema |
Public authoring schema, miner workflow, surface playbooks, atom layouts, writable regions, public artifact links, public corpus links, and reference patch shapes |
GET |
/coretex/public-corpus/manifest |
Public corpus manifest, split policy, endpoint templates, paging limits, and public record fields |
GET |
/coretex/public-corpus/events?offset=N&limit=M |
Paged public visible events; supports includeEmbeddings=true and includePublicQrels=false |
GET |
/coretex/public-corpus/event/:eventId |
One public visible event by id |
GET |
/coretex/public-corpus/entities?offset=N&limit=M |
Paged public entity table |
GET |
/coretex/public-corpus/family-summary |
Query-family counts and bounded representative public examples |
GET |
/coretex/public-corpus/relation-summary |
Public relation edge-type counts and bounded representative public examples |
GET |
/coretex/public-corpus/query-examples?surface=...&family=...&relation=... |
Bounded public examples filtered by intended surface, family, or relation |
GET |
/coretex/substrate/:stateRoot |
Packed 1024-state-cell substrate for a confirmed root |
GET |
/coretex/substrate/:stateRoot?view=decoded |
Compact decoded substrate, structural counts, and resolved public MemoryIndex metadata where available |
POST |
/coretex/dryrun |
Structural validation for { patchBytesHex, parentStateRoot, minerAddress }; no scoring and no wallet intake |
POST |
/coretex/render-trace |
Public renderer activation trace for the exact patch; no scoring and no wallet intake |
POST |
/coretex/submit |
Submit { patchBytesHex, parentStateRoot, minerAddress } |
GET |
/coretex/attempt/:hash?miner=0x... |
Miner-scoped recovery lookup for a submitted patch hash |
GET |
/coretex/receipt/:hash |
Re-fetch a signed receipt, or receive stale/expired status |
Supporting miner endpoints shared with the standard lane:
| Method | Path | Purpose |
|---|---|---|
POST |
/v1/auth/nonce |
Request the exact message to sign for miner authentication |
POST |
/v1/auth/verify |
Verify the signed nonce and receive a bearer token |
GET |
/v1/epoch |
Current epoch and claim/funding context |
GET |
/v1/claim-calldata?epochs=N |
Pre-encoded claim transaction helper |
Important /coretex/status fields:
| Field | Meaning |
|---|---|
currentStateRoot |
Confirmed parent root for the next patch |
allowedPatchTypes |
Live patch type bytes and allowed state-cell ranges |
patchWordBudget |
Maximum changed state cells, currently 4 |
minImprovementPpm |
Base state-advance improvement floor |
stateAdvanceThresholdPpm |
Full state-advance threshold including variance and replay tolerance |
screenerThresholdPpm |
Live screener threshold for base CoreTex credit |
baselineParentScorePpm |
Effective parent baseline for the current live root |
perMiner |
Miner receipt cursor, screener count, cap, and remaining screeners |
qualifiedScreenerPassesSinceLastStateAdvance |
Global since-advance screener counter used for the next state-advance work multiplier; it does not reset merely because the epoch rolls |
activeSubstrateSurfaces |
Reward-active substrate families for the current epoch |
bundleHash, coreVersionHash, corpusRoot, activeFrontierRoot |
Epoch roots and commitments checked against chain state |
minerGuidance |
Schema, dryrun, render-trace, decoded-substrate, timeout-recovery, substrate-bootstrap, and latest accepted shape hints |
Important /coretex/schema fields:
| Field | Meaning |
|---|---|
patchWireFormat |
Compact patch byte layout |
minerWorkflow / surfacePlaybooks |
Live intent-to-shape authoring guidance |
wordRegions |
State-cell ranges and grammar summaries |
memoryIndexSchema |
MemoryIndex slot layout and anchor rules |
relationAtomSchema |
Relation edge and category-lens layouts, edge-type enum, and examples |
temporalAtomSchema |
Temporal record layout and examples |
policyAtomSchema |
PolicyAtom bit layout, enums, per-region action rules, and examples |
publicArtifacts |
Artifact base URLs, public corpus endpoint links, and eval-report URL template |
referencePatchShapes |
Non-secret reference shapes for structural and positive-control orientation |
submitTimeoutRecovery |
Attempt and receipt lookup paths for timeout recovery |
POST /coretex/submit accepts:
{
"patchBytesHex": "0x...",
"parentStateRoot": "0x...",
"minerAddress": "0x..."
}
Accepted responses include the outcome, patchHash, evalReportHash,
workUnitsBps, and the signed V4 receipt. STATE_ADVANCE responses also carry
the new state root and pre-encoded transaction data. Rejections include a stable
code and safe recovery context. Hidden query labels, seeds, pack IDs,
per-query rankings, and score gradients stay out of public responses.
GET /coretex/receipt/:hash works for both the miner-submitted patch hash and
the coordinator-rewritten signed hash. Pending or confirmed receipts return the
receipt envelope. A stale pending receipt returns 409 PendingReceiptStale
without broadcastable transaction data. Expired or unknown receipts return 404.