Upcoming browser-session canonical read. Set to '1' to capture the authorized response and a signed Workspace replay cursor in one snapshot. Apply every required retained read before acknowledging a socket checkpoint. Failed or incomplete reads return no cursor.
Values
1
Responses
ETag
string
Quoted decimal optimistic-concurrency version.
X-Assign-Realtime-Cursor
string·max 4096
Signed Workspace/User/session-bound replay custody; present only after a successful requested canonical baseline.
X-Assign-Realtime-Position
string
Decimal-string snapshot position; present only with a successful baseline cursor.
contract_generationRequired
string
Values
agent-participation.v1
workspace_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
definition_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
actor_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
revisionRequired
integer <int64>·min 1
version_digestRequired
string
updated_at
string
UTC RFC3339 current catalog sort position when returned by the Studio list; absent from immutable revision snapshots and detail responses.
slugRequired
string·min 2·max 80
nameRequired
string·min 1·max 80
descriptionRequired
string·min 1·max 500
responsibilityRequired
string·min 1·max 500
personality
string·max 1000
routing_description
string·max 500
routing_tags
string[]·max 12
instructionsRequired
string·min 1·max 8000
conversation_starters
string[]·max 6
subagent_definition_ids
string <uuid>[]·max 8
approval_policy
string
Values
manage_actionsevery_action
prohibited_actions
string[]·max 12
trigger_types
string[]·min 1·max 3
Values
manualeventschedule
visibility
string
Values
workspace
stateRequired
string
Values
draftactivepaused
mcp_enabled
boolean
Allow permitted Assign MCP operations under this Agent identity. New definitions default to false; omitted updates preserve the current value. Saving false revokes operational access.
bindingsRequired
object[]·max 32
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
