API reference
Brief me
What an agent reads before it starts on something: the decision documents that mention it, open questions about it, the agent's correction rules, the memories that mention it and the links they carry, and what the briefing could not cover.
Needs scope decisions:read.
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.
account_id?stringA team you belong to; empty for your own account.
about?stringA topic in plain words, file:<path> or service:<name>.
agent?stringThe agent asking; its correction rules come first.
space_id?stringOnly this space's documents, questions and memories.
iohr.brief.v1.MeResponse
application/json- response
iohr.brief.v1.MeResponse
about*stringdecisions*array<>gaps*array<string>links*array<string>memories*array<>questions*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.brief.me(); 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.
{ "about": "string", "decisions": [ { "document_id": "string", "kind": "string", "number": "string", "space_id": "string", "status": "string", "summary": "string", "title": "string" } ], "gaps": [ "string" ], "links": [ "string" ], "memories": [ { "account_id": "string", "agent": "string", "decided_by": "string", "kind": "string", "links": [ "string" ], "record_id": "string", "recorded_at": "string", "recorded_by": "string", "redactions": 0, "score": 0.1, "seen": 0, "seen_at": "string", "session": "string", "space_id": "string", "status": "string", "summary_id": "string", "superseded_by": "string", "text": "string", "topics": [ "string" ], "via": "string" } ], "questions": [ { "asked_at": "string", "asked_of": "string", "question_id": "string", "space_id": "string", "text": "string" } ], "rules": [ { "correction_id": "string", "recurrences": 0, "text": "string" } ]}