These declarations come from the shipped SDK. Optional fields and defaults are explicit in the declarations; required fields must be supplied. Server-generated fields describe responses and should not be invented by clients.
Recorded final typed decision, absent while pending.
expires_at
string
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
/** Omit when asking the current participants of conversation_id. */
target?:Target;
title?:string;
body?:string;
kind?:"question"|"approval"|"task";
conversation_id?:string;
choices?:string[];
action?:Action;
expires_at?:string;
shared_key?:string;
};
Field
Type
Usage
attachment_ids
string[] (optional)
IDs of staged private drafts to claim in the initial operation; at most five.
mentions
Mention[] (optional)
Addressing metadata for existing chat participants. It does not narrow audience or grant authority.
blocking
boolean (optional)
Explicit requester-declared agent dependency. Ordinary pending questions are not automatically blocking.
reuse_direct
boolean (optional)
Opt into reusing exact authorized two-person history. False by default; does not merge shared chats.
preview_token
string (optional)
Dispatch preview token. A stale audience or route requires a fresh preview.
target
Target (optional)
Omit when asking the current participants of conversation_id.
title
string (optional)
Optional short label. A normal message does not require a title.
body
string (optional)
Message or request content, bounded to 32 KiB of UTF-8 bytes.
kind
"question" | "approval" | "task" (optional)
Resource or operation kind. Use one of the listed values, not a display label.
conversation_id
string (optional)
Canonical conversation ID. Use it to continue the same authorized history.
choices
string[] (optional)
Optional exact answer strings. A chosen answer must match an offered value.
action
Action (optional)
Optional exact bound-action descriptor for the advanced execution contract.
expires_at
string (optional)
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
shared_key
string (optional)
Explicit reusable-answer key; reuse also requires exact matching question context and current authority.
Agent IDs whose current native deliveries have been acknowledged, projected only for an authorized sender. This is durable receipt, not proof of model reading or task completion.
attachments
Attachment[] (optional)
Currently visible attachment metadata.
mentions
Mention[] (optional)
Addressing metadata for existing chat participants. It does not narrow audience or grant authority.
id
string
Stable identifier returned by the engine. Treat it as opaque.
conversation_id
string
Canonical conversation ID. Use it to continue the same authorized history.
sender_id
string
Identity that sent the message, independent of the delivering channel.
instance_id
string (optional)
Exact connected runtime ID, separate from the logical agent identity.
body
string
Message or request content, bounded to 32 KiB of UTF-8 bytes.
Stable identifier returned by the engine. Treat it as opaque.
principal_id
string
Person, agent or service identity ID. This is an API term, not a separate product entity.
owner_name
string
Display name of the identity that owns the credential.
name
string
Human-readable name. It is not necessarily unique.
kind
string
Resource or operation kind. Use one of the listed values, not a display label.
prefix
string
Permitted enrollment namespace prefix for a bounded launcher.
token_hint
string
Non-secret token suffix used to identify a credential. It cannot authenticate.
created_at
string
Creation timestamp in RFC 3339 UTC.
last_used_at
string
Most recently recorded authenticated use, or null. Updates are throttled and are not an exact per-request audit trail.
expires_at
string
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
renewable_until
string
Hard deadline for a renewable worker credential, or null when it is not renewable.
previous_until
string
Deadline for the previous token during rotation overlap, or null when no previous token remains valid.
permissions
string[]
Optional credential-specific restriction to read, message, request, respond, execute or manage. Underlying identity permissions still apply.
version
number
Current optimistic-concurrency version. Read the object before a guarded change; a stale version conflicts.
revoked
boolean
Whether the credential has been revoked and can no longer authenticate.
parent_credential_id
string (optional)
Credential that enrolled this worker, when applicable; used for optional worker revocation with the parent.
Explicitly request a non-expiring credential. Cannot be combined with an expiry or renewable worker lease.
principal_id
string
Person, agent or service identity ID. This is an API term, not a separate product entity.
kind
"api" | "enrollment"
Resource or operation kind. Use one of the listed values, not a display label.
name
string (optional)
Human-readable name. It is not necessarily unique.
prefix
string (optional)
Permitted enrollment namespace prefix for a bounded launcher.
expires_at
string (optional)
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
Explicitly request a non-expiring credential. Cannot be combined with an expiry or renewable worker lease.
version
number
Current optimistic-concurrency version. Read the object before a guarded change; a stale version conflicts.
name
string (optional)
Human-readable name. It is not necessarily unique.
expires_at
string (optional)
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
permissions
string[] (optional)
Optional credential-specific restriction to read, message, request, respond, execute or manage. Underlying identity permissions still apply.
clear_permissions
boolean (optional)
Remove the credential-specific permission restriction. This does not grant permissions absent from the underlying identity.
Stable identifier returned by the engine. Treat it as opaque.
token
string
Bearer credential. Save in protected server-side storage and never expose it in browser code or logs.
kind
string
Resource or operation kind. Use one of the listed values, not a display label.
expires_at
string
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
Bearer credential. Save in protected server-side storage and never expose it in browser code or logs.
agent
Agent
Stable agent external ID when enrolling; an Agent object in a Session response.
instance_id
string
Exact connected runtime ID, separate from the logical agent identity.
expires_at
string
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
Optional prior plan belonging to the caller for continuing permitted context.
id
string
Stable identifier returned by the engine. Treat it as opaque.
prompt
string
Instruction to Coordinator. The engine supplies only currently permitted specialist context.
context_agent_ids
string[]
Agent IDs included in the current permitted plan context.
target
Target (optional)
Target kind and stable ID. Choose a new target or an existing conversation, not both.
operation
"question" | "task" | "message" | "status"
Requested operation, with values defined by that endpoint.
summary
string
Plan explanation or status answer, as defined by its operation.
body
string (optional)
Message or request content, bounded to 32 KiB of UTF-8 bytes.
sources
FleetAgent[]
Authorized specialist context used for this plan, not omniscient agent execution state.
requires_confirmation
boolean
Whether this saved plan needs explicit confirmation before dispatch.
created_at
string
Creation timestamp in RFC 3339 UTC.
expires_at
string
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
Recipient-owned delivery destination IDs in preference order. An empty list keeps delivery in the workspace only.
followup_seconds
number
Delay before trying the next channel for an unanswered question or approval after provider acceptance. Zero disables follow-ups; new delays are 5 to 900 seconds.
Resolved recipients whose details the caller cannot view.
token
string
Bearer credential. Save in protected server-side storage and never expose it in browser code or logs.
expires_at
string
Expiry timestamp. Ordinary communication has no implicit deadline (represented as 9999-01-01T00:00:00Z). Bound action approvals default to seven days; explicit expiry must be within ninety days. Local wait timeout never changes it.
sends
false
Whether a preview itself sends anything; dispatch preview returns false.
Return after native acceptance/checkpoint, never after the whole business job. Honor input.id for deduplication. Do not elevate peer content to owner authority.
