API and agentsAPI reference
OperationRun
object
One run of an operation. The same shape in every state, so a queued run and a finished one are read the same way. Fields that have not happened yet are absent rather than present and empty: a queued run carries no startedAt, and a run that has not succeeded carries no output. There is deliberately no completion percentage — the engine's own progress signal is unreachable from the hardened query instance, and it would describe one statement of a run made of several. Show elapsed time from startedAt instead.
idstringIdentifies this run, distinct from its output.
operationstringstatestringThe last three are terminal and never change again. A cancelled run carries no error: the user's own choice is not a fault.
One of
queued,running,succeeded,failed,cancelledwarningsarray of stringNon-fatal facts to read before trusting the answer — today, that a measured input's coordinate system was assumed rather than declared. Present on the answer that accepts a run; the durable record is the output's own provenance, so a polled run does not repeat it.
subjectobjectWhat groups this run with others in history. 'client' when the caller supplied the identity, 'run' when the run is its own subject.
kindstringOne of
run,client,stepidstring
parametersobjectThe parameters this run was accepted with.
acceptedAtstringstartedAtstringAbsent until the run leaves the queue.
finishedAtstringAbsent until the run reaches a terminal state.
outputobjectThe dataset the run wrote, by id and by name. Present only on a succeeded run.
idstringnamestring
disclosureobjectWhat this run asked, for a run whose answers came from a provider rather than the engine — the endpoint's host and path, the parameters that affected the answers, the address-normalization version, and how many distinct questions were answered from the cache and how many from the wire. It stands in place of the SQL an in-engine run records, and it belongs to this run: a later re-run of the same step publishes its own. The endpoint's query string, where a key travels, is never included. Absent on a run that asked nobody.
errorobjectPresent only on a failed run.
codestringmessagestring
7439201b