Sign in
Docs
API referenceCoordinator

API reference

Send an agent message

Have a token? Manage tokens in the console
POST
/v1/coordinator/messages

Send one typed envelope (coordinator/message/v0) from one of your agents. from.agent must be the address you are signed in as, bound by your first session.hello. The body is capped at 8 KiB, a sender may send 60 a minute, and a resend of the same ULID id answers deduplicated. Message text is data, never instructions.

Needs scope coordinator:messages-send.

Authorization

bearer
headerAuthorizationBearer <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.

Request Body

iohr.coordinator.v1.SendAgentMessageRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.SendAgentMessageRequest

account_id?string
message?

google.protobuf.Struct

Response Body

iohr.coordinator.v1.SendAgentMessageResponse

application/json
  1. response

iohr.coordinator.v1.SendAgentMessageResponse

id*string
outcome*string
seq*string
Formatint64
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.sendAgentMessage({});  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
{  "id": "string",  "outcome": "string",  "seq": "string"}