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.
Optional prior plan belonging to the caller for continuing permitted context.
Target
*Target
Target kind and stable ID. Choose a new target or an existing conversation, not both.
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.
ContextIDs
[]string
Agent IDs included in the current permitted plan context.
Operation
string
Requested operation, with values defined by that endpoint.
Summary
string
Plan explanation or status answer, as defined by its operation.
Body
string
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.
RequiresConfirmation
bool
Whether this saved plan needs explicit confirmation before dispatch.
CreatedAt
time.Time
Creation timestamp in RFC 3339 UTC.
ExpiresAt
time.Time
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.
Dispatches
[]OverseerDispatch
Attributed conversation/request IDs created by a confirmed or automatic plan.
Replies
[]Request
Specialist requested decisions visible to the current caller.
ReplySummary
string
Model-generated summary of the authorized replies, including pending/missing evidence.
ReplyDigest
string
Digest identifying the reply evidence used by the summary.
// AssistanceTimeout applies only to model-backed planning and summaries.
// Zero uses 40 seconds; a shorter caller context still takes precedence.
AssistanceTimeout time.Duration
// MaxResponseBytes bounds decoded responses. Zero uses 256 MiB, covering the
// API's bounded 1000-recipient fan-out even with JSON escaping. Decoding streams.
MaxResponseBytesint64
}
Field
Type
Usage
BaseURL
string
Engine origin, including scheme and optional port. No embedded credentials.
Token
string
Bearer credential. Save in protected server-side storage and never expose it in browser code or logs.
HTTP
*http.Client
Go HTTP client/transport override. New uses a 20-second timeout; contexts can impose a shorter deadline.
AssistanceTimeout
time.Duration
AssistanceTimeout applies only to model-backed planning and summaries. Zero uses 40 seconds; a shorter caller context still takes precedence.
MaxResponseBytes
int64
MaxResponseBytes bounds decoded responses. Zero uses 256 MiB, covering the API’s bounded 1000-recipient fan-out even with JSON escaping. Decoding streams.
Explicitly request a non-expiring credential. Cannot be combined with an expiry or renewable worker lease.
ConnectionName
string
Human-readable label for this Agent runtime connection.
Renewable
bool
Use a renewable 24-hour worker lease bounded by the supplied hard expiry. Renewal never extends the hard deadline.
ExpiresAt
*time.Time
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.
ParentID
string
Optional parent agent identity for a deliberately bounded enrollment.
Agent
string
Stable agent external ID when enrolling; an Agent object in a Session response.
Name
string
Human-readable name. It is not necessarily unique.
Capabilities
[]string
Application-declared runtime capabilities. This does not grant contact permission.
Metadata
map[string]any
Application-supplied JSON metadata. Do not put credentials here.
IDs of staged private drafts to claim in the initial operation; at most five.
Mentions
[]Mention
Addressing metadata for existing chat participants. It does not narrow audience or grant authority.
Blocking
bool
Explicit requester-declared agent dependency. Ordinary pending questions are not automatically blocking.
ReuseDirect
bool
Opt into reusing exact authorized two-person history. False by default; does not merge shared chats.
PreviewToken
string
Dispatch preview token. A stale audience or route requires a fresh preview.
Target
Target
Target kind and stable ID. Choose a new target or an existing conversation, not both.
ConversationID
string
Canonical conversation ID. Use it to continue the same authorized history.
Kind
string
Resource or operation kind. Use one of the listed values, not a display label.
Title
string
Optional short label. A normal message does not require a title.
Body
string
Message or request content, bounded to 32 KiB of UTF-8 bytes.
Choices
[]string
Optional exact answer strings. A chosen answer must match an offered value.
ExpiresAt
*time.Time
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.
Action
*Action
Optional exact bound-action descriptor for the advanced execution contract.
SharedKey
string
Explicit reusable-answer key; reuse also requires exact matching question context and current authority.
Addressing metadata for existing chat participants. It does not narrow audience or grant authority.
Blocking
bool
Explicit requester-declared agent dependency. Ordinary pending questions are not automatically blocking.
RequesterInstanceID
string
Runtime that initiated the request, when applicable.
ID
string
Stable identifier returned by the engine. Treat it as opaque.
ConversationID
string
Canonical conversation ID. Use it to continue the same authorized history.
RequesterID
string
Identity that opened the requested decision.
Kind
string
Resource or operation kind. Use one of the listed values, not a display label.
Title
string
Optional short label. A normal message does not require a title.
Body
string
Message or request content, bounded to 32 KiB of UTF-8 bytes.
Choices
[]string
Optional exact answer strings. A chosen answer must match an offered value.
State
string
Lifecycle state. Read the resource-specific enum; request and execution states differ.
Version
int
Current optimistic-concurrency version. Read the object before a guarded change; a stale version conflicts.
Response
*Response
Recorded final typed decision, absent while pending.
Action
*Action
Optional exact bound-action descriptor for the advanced execution contract.
ExpiresAt
time.Time
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.
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
Currently visible attachment metadata.
Mentions
[]Mention
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.
ConversationID
string
Canonical conversation ID. Use it to continue the same authorized history.
Body
string
Message or request content, bounded to 32 KiB of UTF-8 bytes.
SenderID
string
Identity that sent the message, independent of the delivering channel.
InstanceID
string
Exact connected runtime ID, separate from the logical agent identity.
Stable identifier returned by the engine. Treat it as opaque.
PrincipalID
string
Person, agent or service identity ID. This is an API term, not a separate product entity.
Name
string
Human-readable name. It is not necessarily unique.
OwnerName
string
Display name of the identity that owns the credential.
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.
TokenHint
string
Non-secret token suffix used to identify a credential. It cannot authenticate.
CreatedAt
time.Time
Creation timestamp in RFC 3339 UTC.
LastUsedAt
*time.Time
Most recently recorded authenticated use, or null. Updates are throttled and are not an exact per-request audit trail.
ExpiresAt
*time.Time
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.
RenewableUntil
*time.Time
Hard deadline for a renewable worker credential, or null when it is not renewable.
PreviousUntil
*time.Time
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
int64
Current optimistic-concurrency version. Read the object before a guarded change; a stale version conflicts.
Revoked
bool
Whether the credential has been revoked and can no longer authenticate.
ParentCredentialID
string
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.
PrincipalID
string
Person, agent or service identity ID. This is an API term, not a separate product entity.
Kind
string
Resource or operation kind. Use one of the listed values, not a display label.
Name
string
Human-readable name. It is not necessarily unique.
Prefix
string
Permitted enrollment namespace prefix for a bounded launcher.
ExpiresAt
*time.Time
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 credential-specific restriction to read, message, request, respond, execute or manage. Underlying identity permissions still apply.
Explicitly request a non-expiring credential. Cannot be combined with an expiry or renewable worker lease.
Version
int64
Current optimistic-concurrency version. Read the object before a guarded change; a stale version conflicts.
Name
*string
Human-readable name. It is not necessarily unique.
ExpiresAt
*time.Time
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 credential-specific restriction to read, message, request, respond, execute or manage. Underlying identity permissions still apply.
ClearPermissions
bool
Remove the credential-specific permission restriction. This does not grant permissions absent from the underlying identity.
Recipient-owned delivery destination IDs in preference order. An empty list keeps delivery in the workspace only.
FollowupSeconds
int
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.
ExpiresAt
time.Time
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
bool
Whether a preview itself sends anything; dispatch preview returns false.
ReplaceRequest retires an own pending request and sends a fresh decision to
its unchanged audience. Keep the key stable when retrying an unknown result.
type ReplaceRequestInput struct {
Versionint`json:"version"`
Bodystring`json:"body"`
Mentions []Mention `json:"mentions,omitempty"`
}
Field
Type
Usage
Version
int
Current optimistic-concurrency version. Read the object before a guarded change; a stale version conflicts.
Body
string
Message or request content, bounded to 32 KiB of UTF-8 bytes.
Mentions
[]Mention
Addressing metadata for existing chat participants. It does not narrow audience or grant authority.
