Message reference

Every OCP 1.0 message and core object, generated from the normative Zod contracts. Message tables show the payload fields (the envelope {v, id, type, ts, sid?, replyTo?} is common to all). Each links to its machine-readable JSON Schema.

Messages

action.request

action-request.json

Field	Type	Req.	Constraints
actionId	string	✓	len 10–64
tool	string	✓
input	object	✓
turnId	string

action.result

action-result.json

Field	Type	Req.	Constraints
actionId	string	✓
ok	boolean	✓
output	any
error	string		len 0–500

context.set

context-set.json

Field	Type	Req.	Constraints
rev	integer	✓	≥ 0
url	string		len 0–2048
resource	object
selection	object
view	object

error

error-message.json

Field	Type	Req.	Constraints
code	"AUTH_EXPIRED" \| "SCOPE_DENIED" \| "RATE_LIMITED" \| "NONCE_USED" \| "SESSION_GONE" \| "TURN_ABORTED" \| "CONTEXT_TOO_LARGE" \| "PAIR_DENIED" \| "UNSUPPORTED" \| "INTERNAL"	✓
message	string	✓	len 0–500
retryable	boolean	✓
details	object

session.heartbeat

heartbeat.json

No fields.

pair.approval_request

pair-approval-request.json

Field	Type	Req.
claimId	string	✓
device	object	✓
expiresAt	integer	✓

pair.approval_response

pair-approval-response.json

Field	Type	Req.	Constraints
claimId	string	✓
approved	boolean	✓

pair.linked

pair-linked.json

Field	Type	Req.
device	object	✓
scopes	string[]	✓
tier	"t0" \| "t1" \| "t2"	✓

pair.revoked

pair-revoked.json

Field	Type	Req.	Constraints
by	"surface" \| "hub" \| "admin"	✓

session.closed

session-closed.json

Field	Type	Req.	Constraints
reason	"surface_gone" \| "revoked" \| "ttl_idle" \| "ttl_absolute" \| "error" \| "user"	✓

session.linked

session-linked.json

Field	Type	Req.
sid	string	✓
capabilities	object	✓
tier	"t0" \| "t1" \| "t2"	✓
scopes	string[]	✓
resumeKey	string

session.open

session-open.json

Field	Type	Req.	Constraints
capabilities	object	✓
resumeKey	string		len 16–256

session.refresh

session-refresh.json

No fields.

session.refreshed

session-refreshed.json

Field	Type	Req.	Constraints
token	string	✓	len 20–∞
expiresIn	integer	✓

session.resumed

session-resumed.json

Field	Type	Req.	Constraints
peer	"surface" \| "companion"	✓

session.suspended

session-suspended.json

Field	Type	Req.	Constraints
peer	"surface" \| "companion"	✓
graceMs	integer	✓

tools.advertise

tools-advertise.json

Field	Type	Req.	Constraints
tools	object[]	✓

turn.cancel

turn-cancel.json

Field	Type	Req.	Constraints
turnId	string	✓

turn.citation

turn-citation.json

Field	Type	Req.	Constraints
turnId	string	✓
index	integer	✓
resource	object	✓
quote	string		len 0–500

turn.delta

turn-delta.json

Field	Type	Req.	Constraints
turnId	string	✓
text	string	✓

turn.done

turn-done.json

Field	Type	Req.	Constraints
turnId	string	✓
contextRev	integer		≥ 0
usage	object

turn.error

turn-error.json

Field	Type	Req.	Constraints
turnId	string	✓
code	"TURN_ABORTED" \| "RATE_LIMITED" \| "SCOPE_DENIED" \| "INTERNAL"	✓
message	string	✓	len 0–500

turn.input

turn-input.json

Field	Type	Req.	Constraints
turnId	string	✓	len 10–64
text	string		len 1–8000
audioRef	string		len 0–512
lang	string		len 2–35

ui.request

ui-request.json

Field	Type	Req.	Constraints
requestId	string	✓	len 10–64
kind	"confirm" \| "choice" \| "notice"	✓
title	string	✓	len 0–200
body	string		len 0–2000
options	object[]
expiresAt	integer	✓
actionId	string

ui.response

ui-response.json

Field	Type	Req.	Constraints
requestId	string	✓
result	string	✓	len 0–64
peer	"surface" \| "companion"	✓

Core objects

any-message

any-message.json

No fields.

capabilities

capabilities.json

Field	Type	Req.
profiles	object[]	✓
stt	"device" \| "hub" \| "none"
tts	"device" \| "hub" \| "none"
locales	string[]
audio	boolean
tools	boolean

context

context.json

Field	Type	Req.	Constraints
rev	integer	✓	≥ 0
url	string		len 0–2048
resource	object
selection	object
view	object

embed-config

embed-config.json

Field	Type	Req.	Constraints
siteKey	string	✓	len 1–128
hub	string	✓	uri
allowedOrigins	string[]

envelope

envelope.json

Field	Type	Req.	Constraints
v	string	✓
id	string	✓	len 10–64
type	string	✓	len 1–64
ts	integer	✓
sid	string		len 16–128
replyTo	string		len 10–64
payload	any

error-code

error-code.json

No fields.

error-payload

error-payload.json

Field	Type	Req.	Constraints
code	"AUTH_EXPIRED" \| "SCOPE_DENIED" \| "RATE_LIMITED" \| "NONCE_USED" \| "SESSION_GONE" \| "TURN_ABORTED" \| "CONTEXT_TOO_LARGE" \| "PAIR_DENIED" \| "UNSUPPORTED" \| "INTERNAL"	✓
message	string	✓	len 0–500
retryable	boolean	✓
details	object

host-to-widget

host-to-widget.json

No fields.

pair-claim

pair-claim.json

Field	Type	Req.	Constraints
jws	string	✓	len 20–∞
devicePubKey	object	✓
attestation	string
device	object	✓

pair-token-claims

pair-token-claims.json

Field	Type	Req.	Constraints
v	string	✓
iss	string	✓	uri
sid	string	✓	len 22–∞
nonce	string	✓	len 22–∞
exp	integer	✓
iat	integer	✓
cap	string	✓	uri

profile-ref

profile-ref.json

Field	Type	Req.	Constraints
name	"core" \| "embed" \| "companion" \| "provider"	✓
version	string	✓

resource-ref

resource-ref.json

Field	Type	Req.	Constraints
kind	string	✓	len 1–64
id	string	✓	len 1–256
title	string		len 0–500

tool-def

tool-def.json

Field	Type	Req.	Constraints
name	string	✓	len 1–128
description	string	✓	len 0–1000
inputSchema	object	✓
location	"hub" \| "surface"	✓
write	boolean

well-known

well-known.json

Field	Type	Req.	Constraints
ocp	object	✓
issuer	string	✓	uri
jwks_uri	string	✓	uri
ws_endpoint	string	✓	uri
profiles	object[]	✓

widget-to-host

widget-to-host.json

No fields.