PUT /api/agents/{agentId}/listener-runs/{runId}

Report this listener#

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

• Authentication, envelopes and pagination
• Language-neutral client examples

Path parameters#

object; fields below; unknown fields rejected

Validation#

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

Referenced definitions:

• object
• identifier

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#

object; fields below; unknown fields rejected ( heartbeat )

Additional checks#

The following checks apply in addition to the field limits.

Constraint on statistics:

value => value.endedAt >= value.startedAt && new Set(value.flows.map(flow => JSON.stringify([flow.roomId, flow.senderMatrixId, flow.messageType]))).size === value.flows.length
    && new Set(value.usage.map(sample => JSON.stringify([sample.runtime, sample.sessionId]))).size === value.usage.length

Constraint on statistics.usage[].tokens:

value => value.cachedInput <= value.input && (value.cacheWriteInput ?? 0) <= value.input
    && (value.reasoningOutput ?? 0) <= value.output

Validation#

req.heartbeat

Referenced definitions:

• heartbeat

Response data#

object; fields below; unknown fields rejected ( report )

Validation#

res.report

Referenced definitions:

• report

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"
  }
}