API referenceCoordinator
API reference
Get a step
Have a token? Manage tokens in the console
GET
One step, its definition and digest, at a version or the newest.
Needs scope coordinator:read.
bearerheader
AuthorizationBearer <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.
step_id*stringThe step's id, as its definition names it.
version?integerThe version; 0 is the newest.
Format
int32account_id?stringThe account; empty is the caller's own.
iohr.coordinator.v1.GetStepResponse
application/json- response
iohr.coordinator.v1.GetStepResponse
step?iohr.coordinator.v1.Step
SDK
HTTP
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.getStep("<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
{ "step": { "author": "string", "capabilities": [ "string" ], "created_at": "string", "definition": "string", "digest": "string", "facts": [ "string" ], "id": "string", "key_id": "string", "kind": "string", "limits": { "fuel": "string", "host_calls": 0, "memory_bytes": "string", "output_bytes": 0, "wall_ms": 0 }, "signed": true, "size_bytes": "string", "title": "string", "version": 0 }}