Sends one check to an online agent and waits up to 30 seconds for its result: ok, failed or refused by the agent's local policy, with the latency, the HTTP status and an error class, never a body. A named host must be inside the agent's verified domains; a private address or an internal name goes to the agent, whose policy decides. auth is a reference the agent resolves in your secret store (vault:, k8s:, env:, file:), never a secret.
Needs scope agents:write.
bearerAuthorizationBearer <token>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
agent_id*stringThe agent's id (agt_…), from List agents.
idempotency-key?stringMakes a retry safe: a repeat with the same key and the same body within a day answers what the first call did (with Idempotency-Replayed: true) instead of running again; the same key with another body is 422 unprocessable. 1 to 255 visible characters; a UUID is a good one.
1 <= length <= 255iohr.agents.v1.RunCheckRequest; path variables override their fields
application/json- body
iohr.agents.v1.RunCheckRequest
agent_id?stringauth?stringexpect?iohr.agents.v1.Expect
org_id?stringservice?stringsurface?stringtarget?iohr.agents.v1.Target
iohr.agents.v1.RunCheckResponse
application/json- response
iohr.agents.v1.RunCheckResponse
result?iohr.agents.v1.JobResult
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.agents.runCheck("<org_id>", "<agent_id>", { auth: "<auth>", service: "<service>", surface: "<surface>", }); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}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.
{ "result": { "detail": { "error_class": "string", "invariants": [ { "expected": "string", "name": "string", "path": "string", "status": "string" } ], "latency_ms": 0, "ok": true, "status_code": 0, "tls_expires_at": "string" }, "finished_at": "string", "job_id": "string", "refusal": { "reason": "string" }, "started_at": "string", "status": "string" }}Delete an agent DELETE
Revokes the agent if it is not already, then takes it off the list. Needs scope `agents:write`.
List spaces GET
The account's spaces, newest first: one per system, each with its documents' counts by status and when it last changed. `query` matches the name. Paged with `page_size` and `next_page_token`. Needs scope `rfc:read`.