52bf0279Claim one due scheduled input for this native session#
| Property | Value |
|---|---|
| Service | crossfire |
| Operation | claimWake |
| Method | POST |
| Path | /api/agents/{agentId}/wake-deliveries |
| Authentication | agent |
| Success status | 200 |
| Response data | Unpaginated value |
| Request format | json |
| Maximum request body | 2097152 bytes (service default) |
| Permission codes | wake-delivery.receive.self |
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.noneReferenced definitions:
Request body#
object; fields below; unknown fields rejected (
wakeAttachment
)
| Field path | Representation and constraints |
|---|---|
runId | lowercase opaque UUID |
sessionId | string; 1–200 UTF-16 units; well-formed Unicode; no C0/DEL controls |
Validation#
wake.wakeAttachmentReferenced definitions:
Response data#
object; fields below; unknown fields rejected (
scheduledWake
); JSON null permitted
| Field path | Representation and constraints |
|---|---|
deliveryId | lowercase opaque UUID |
ruleId | lowercase opaque UUID |
ruleRevision | exact JSON integer; 0…9007199254740991 |
name | string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls; constraint: Provide a Wake-up name (
name
) |
message | plain-text string; at most 16384 UTF-8 bytes; allowed whitespace controls only; constraint: Provide a wake-up message (
message
) |
scheduledAt | exact JSON integer; 0…9007199254740991 |
sessionId | string; 1–200 UTF-16 units; well-formed Unicode; no C0/DEL controls |
ownerMatrixId | well-formed Matrix user ID; maximum 255 UTF-16 units |
authorizerMatrixId | well-formed Matrix user ID; maximum 255 UTF-16 units |
Additional checks#
The following checks apply in addition to the field limits.
Constraint on message:
value => !!value.trim()Validation#
check.nullable(wake.scheduledWake)Referenced definitions:
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"
}
}