API reference
Record a step of work
Records one step of work from a CI step, a merge runner, a deploy script or an AI agent: its kind, action, subject, who did it (actor_kind, actor) and optionally a title, an https url and an outcome. at defaults to now. Append only; leave title empty to keep your words on your side.
Needs scope agents:write.
bearerAuthorizationBearer <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.
org_id*stringThe account's id: org in GET /v1/me.
iohr.agents.v1.RecordWorkRequest; path variables override their fields
application/json- body
iohr.agents.v1.RecordWorkRequest
action?stringactor?stringactor_kind?stringat?stringkind?stringorg_id?stringoutcome?stringsubject?stringtitle?stringurl?stringiohr.agents.v1.RecordWorkResponse
application/json- response
iohr.agents.v1.RecordWorkResponse
item?iohr.agents.v1.WorkItem
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.recordWork("<org_id>", { action: "<action>", actor: "<actor>", actor_kind: "<actor_kind>", at: "<at>", }); 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.
{ "item": { "action": "string", "actor": "string", "actor_kind": "string", "at": "string", "id": "string", "kind": "string", "outcome": "string", "recorded_by": "string", "subject": "string", "title": "string", "url": "string" }}