Sign in
InOrbit
Docs
Have a token? Manage tokens in the console
GET
/v1/corrections/rules

The briefing an agent reads when a session starts: the adopted rules for that agent first, then every agent's, each with how often it was broken again, and the newest open corrections.

Needs scope decisions:read.

Authorization

bearer
headerAuthorizationBearer <token>

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.

Query Parameters

account_id?string

A team you belong to; empty for your own account.

agent?string

The agent the briefing is for.

space_id?string

The account-wide rules and this space's.

Response Body

iohr.corrections.v1.RulesResponse

application/json
  1. response

iohr.corrections.v1.RulesResponse

open*array<>
rules*array<>
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.corrections.rules();  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.

{  "open": [    {      "account_id": "string",      "agent": "string",      "correction_id": "string",      "evidence": [        "string"      ],      "expected": "string",      "kind": "string",      "noticed_by": "string",      "recorded_at": "string",      "recorded_by": "string",      "recurrences": 0,      "recurs": "string",      "rule": "string",      "session": "string",      "severity": "string",      "space_id": "string",      "status": "string",      "updated_at": "string",      "updated_by": "string",      "via": "string",      "what_happened": "string"    }  ],  "rules": [    {      "agent": "string",      "correction_id": "string",      "kind": "string",      "recurrences": 0,      "since": "string",      "status": "string",      "text": "string"    }  ]}

List corrections GET

An account's corrections, newest first. Needs scope `decisions:read`.

Update a correction PATCH

Change a correction's status or its rule's wording. An assistant may adopt a rule or mark it recurred; only a person verifies. Needs scope `decisions:write`.