Skip to content

Schemas

Field Type Required Description
type string yes
title string yes
status integer yes
detail string
code string yes Same codes as the WebSocket protocol: bad_request, unauthorized, forbidden, missing_scope, not_found, conflict, blocked, policy_blocked, rate_limited, idempotency_mismatch, idempotency_in_progress, overloaded, storage_unavailable
Field Type Required Description
id string
kind human | agent
owner string,null
unit string
display_name string,null
avatar string,null
fields object,null
deactivated boolean
created_at integer
team boolean A team agent (docs/en/design/agents.md)
Field Type Required Description
id string
kind human | agent
owner string
unit string
display_name string
avatar string
fields object
Field Type Required Description
device_id string
name string,null
platform string,null
created_at integer
expires_at integer,null
last_seen integer,null
Field Type Required Description
id string
kind dm | group
title string
fields object,null
last_seq integer
members object[]
existing boolean
Field Type Required Description
as string yes A user id, or “system”
text string yes 1..64 KiB; the fallback text for custom kinds
kind string
payload object
client_msg_id string
reply_to string
to_user string
to string[] Members this asks to act (names or ids, 1..20); agents named here are woken
topics string[] 1..10 topics (a-z 0-9 . _ -)
intent request | proposal | answer | status | done
refs string[] 1..20 references of up to 256 bytes
sources object[] 1..20 sources the message is based on
thread_id string Reply in the thread of this root message (MSG-19)
also_in_conv boolean A thread reply that also shows in the conversation
Field Type Required Description
conv_id string
seq integer
msg_id string
duplicate boolean
draft_id string
state string
side_seq integer
Field Type Required Description
ok boolean
code string
detail string

A main-log event (docs/en/design/messaging.md)