Sign in
Docs
API referenceCoordinator

API reference

Run a step

Have a token? Manage tokens in the console
POST
/v1/coordinator/steps/{step_id}/evaluate

Run a step in the sandbox (fuel, memory, host calls and time bounded; no network, files, clock or randomness). A replay runs on the facts given; a live run (live: true) needs a signed step and runs on the facts given or on a job's. An admin, with steps:write. Answers the verdict and the record; the record keeps ids, outcome, fuel and time, never the facts or the verdict's words. A result is not applied to the job.

Needs scope steps:write.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

step_id*string

The step's id, as its definition names it.

Request Body

iohr.coordinator.v1.EvaluateStepRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.EvaluateStepRequest

account_id?string
envelope?

iohr.coordinator.v1.StepEnvelope

job_id?string
live?boolean
step_id?string
version?integer
Formatint32

Response Body

iohr.coordinator.v1.EvaluateStepResponse

application/json
  1. response

iohr.coordinator.v1.EvaluateStepResponse

evaluation?

iohr.coordinator.v1.StepEvaluation

logs*array<string>
verdict?

iohr.coordinator.v1.StepVerdict

import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.coordinator.evaluateStep("<step_id>", {});  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "evaluation": {    "created_at": "string",    "digest": "string",    "duration_ms": "string",    "fuel_used": "string",    "id": "string",    "job_id": "string",    "limit_hit": "string",    "mode": "string",    "outcome": "string",    "result": "string",    "step_id": "string",    "subject": "string",    "version": 0  },  "logs": [    "string"  ],  "verdict": {    "ask": "string",    "cites": [      "string"    ],    "deadline_s": 0,    "decision": "string",    "escalation": "string",    "reason": "string",    "rule": "string",    "what": "string"  }}