Protocol version 1.0.0, described by OpenRPC 1.3.2.
This page is generated from the checked-in OpenRPC document. Method names, parameters, results, and transport capabilities below are projections of that document.
watch, logs, and agent/attach each establish a subscription through one JSON-RPC result. run/watch, run/logs, and run/attach use the same framing. The connection layer establishes all six subscriptions; Dispatcher::dispatch alone cannot answer them. After establishment, every subscription uses the generic notification methods below. No method-specific event, cancel, or closed names exist on the wire: watch/event, watch/cancel, watch/closed, logs/event, logs/cancel, logs/closed, agent/attach/event, agent/attach/cancel, and agent/attach/closed are not methods. $/cancelRequest asks the transport to cancel an in-flight unary request by its RequestId. An unknown or already-completed ID is ignored, and cancellation makes no rollback claim after backend state commits.
Read-only vector-backed request inbox. Requires request_ask, kind openengine.request-ask/v1, in target discovery. Reads do not apply expiry or start a successor.
Read-only vector-backed request inbox. Requires request_ask, kind openengine.request-ask/v1, in target discovery. Reads do not apply expiry or start a successor.
Lists checkpoints in increasing sequence order. The after cursor is exclusive. Omitted limit means 50; accepted limits are 1 through 100. Concurrent groups, including every map wave and nested child, expose one entry point. Storage and execution seeds remain private to the target.
Omitting from or selecting restart restarts a failed run where it started, on the latest retained workspace: a submitted run at its graph root, a successor at the boundary it began at, so an accepted answer stays accepted. Selecting checkpoint restores the matching workspace and predecessor outputs and reruns the named node or atomic concurrent group. Original admission and delivery metadata remain fixed. Credentials are resolved again for the successor. Checkpoint continuations and suspended successors restore captured node-instance provider conversations, and so does a restart of such a successor; the restart of a submitted run starts new ones. Suspended command/wait runs continue without restoring files. Request suspensions require from.kind answer with signals and output, or explicit expiry. Requests require request_ask (openengine.request-ask/v1); deadline expiry settles the held verifier with timeout.
{"anyOf":[{"$ref":"#/$defs/RunResumeFrom"},{"type":"null"}],"description":"Omission preserves restarting from the latest retained workspace."}
connections
No
{"additionalProperties":false,"description":"Fresh static connection values for the successor attempt.","patternProperties":{"^[^\u0000-\u001f\u007f-\u009f]+$":{"$ref":"#/$defs/StaticConnectionValues"}},"type":"object"}
connectionResolver
No
{"anyOf":[{"$ref":"#/$defs/TargetConnectionResolver"},{"type":"null"}],"description":"Run-scoped callback used to resolve fresh dynamic connection values."}
githubToken
No
{"description":"Fresh GitHub credential for private source checkout or Git delivery.","type":["string","null"]}
gitCredentials
No
{"anyOf":[{"$ref":"#/$defs/GitTransportCredentials"},{"type":"null"}],"description":"Fresh generic Git authority, excluded from immutable source and submission identity."}
commitIdentity
No
{"anyOf":[{"$ref":"#/$defs/CommitIdentity"},{"type":"null"}],"description":"Author and committer of every commit the successor's delivery creates. Omission keeps the\ntarget's default delivery identity."}
commitCoAuthor
No
{"anyOf":[{"$ref":"#/$defs/CommitIdentity"},{"type":"null"}],"description":"Person credited by a Co-authored-by trailer on every commit carrying the successor's\nchanges. Author and committer stay as commitIdentity selects."}