GET /api/agents/{agentId}/runtime-observations

Generated from services/crossfire/node/packages/contracts/src/rest/operations.ts at 52bf0279

Public configured and effective native runtime settings#

Property	Value
Service	`crossfire`
Operation	`runtimeObservations`
Method	`GET`
Path	`/api/agents/{agentId}/runtime-observations`
Authentication	`either`
Success status	`200`
Response data	Unpaginated value
Request format	`json`
Maximum request body	2097152 bytes (service default)
Permission codes	`agent.read.self`, `agent.read.owned`, `agent.read.any`

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

Path parameters#

object; fields below; unknown fields rejected

Field path	Representation and constraints
`agentId`	lowercase opaque UUID

Validation#

check.object({ agentId: check.identifier })

Referenced definitions:

Query parameters#

custom validation: none ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function none(input: unknown) {
    const parsed = listQuery([])(input);
    return parsed.ok ? success({}) : parsed;
}

Validation#

query.none

Referenced definitions:

none

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

empty

Response data#

array; 0–2002 entries; item: object; fields below; unknown fields rejected ( observationView ) ( observations )

Field path	Representation and constraints
`[].runId`	lowercase opaque UUID
`[].sessionId`	string; 1–255 UTF-16 units; well-formed Unicode; no C0/DEL controls
`[].roomId`	immutable Matrix room ID; maximum 255 UTF-16 units; JSON null permitted
`[].runtime`	lowercase name; pattern `[a-z][a-z0-9-]{0,39}`
`[].state`	`idle` or `working` or `waiting-approval` or `waiting-answer` or `failed` or `unavailable` or `sleeping` or `waking` ( `runtimeState` )
`[].observedAt`	exact JSON integer; 0…9007199254740991
`[].lastActivityAt`	exact JSON integer; 0…9007199254740991; JSON null permitted
`[].historyAvailable`	boolean; JSON null permitted
`[].historyMode`	`shared` or `per-room`
`[].maxInputBytes`	exact JSON integer; 1024…4194304
`[].settings`	array; 0–100 entries; item: object; fields below; unknown fields rejected ( `setting` )
`[].settings[].name`	string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls
`[].settings[].configured`	string; 1–1000 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted
`[].settings[].effective`	string; 1–1000 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted
`[].errorMessage`	plain-text string; at most 4000 UTF-8 bytes; allowed whitespace controls only; JSON null permitted

Validation#

runtime.observations

Referenced definitions:

observations

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001"
  }
}

Page source Source revisions