Skip to content

Admit a narrowed chat session

POST
/chat-session/open
curl --request POST \
--url https://auth.example.invalid/chat-session/open \
--header 'Content-Type: application/json' \
--data '{ "idpToken": "example", "holderHash": "example", "read": [ "example" ], "post": [ "example" ], "ttlSec": 1, "label": "example" }'

Fresh JSON IdP proof derives owner. Body is closed; unknown or missing fields are 400 before proof verification. Uses holderHash and the current cli parent grant; does not accept a caller-selected actor. Origin is refused. Effect failures preserve native code and outcome; missing native outcome means unknown. Retain the same holder on an uncertain retry. Credential verification and native dispatch failures share the public peer refusal budget.

UTF-8 JSON; maximum 65536 bytes. An Authorization header does not replace the JSON proof.

Media typeapplication/json

Lists contain at most 64 distinct concrete channel names and are narrowed to the current cli parent grant. holderHash is SHA-256 of a client-held proof. Reuse the holder identity on uncertain retries; opening never extends its fixed expiry.

object
idpToken
required
string
>= 1 characters
holderHash
required
string
/^[0-9a-f]{64}$/
read
required
Array<string>
<= 64 items
post
required
Array<string>
<= 64 items
ttlSec
required
integer
>= 1 <= 28800
label
string
>= 1 characters <= 128 characters

Examplegenerated

{
"idpToken": "example",
"holderHash": "example",
"read": [
"example"
],
"post": [
"example"
],
"ttlSec": 1,
"label": "example"
}

Successful response.

Media typeapplication/json
object
actor
required
string
/^chat_[a-z2-7]{26}$/
lifecycleUid
required
string
>= 1 characters
expiresAt
required
integer

Examplegenerated

{
"actor": "example",
"lifecycleUid": "example",
"expiresAt": 1
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

JSON error. Route guards run before proof evaluation; parser failures are 400 and byte overflow is 413. An unexpected failure is 400 unless a route handles it separately.

Media typeapplication/json
object
error
required
string
code
string
outcome
string
Allowed values: not-executed executed unknown

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Native refusal where code and outcome are supplied by the chat handler. Pre-dispatch method, Origin, media type and shape refusals are not-executed. Native outcome may be not-executed, executed or unknown. JSON parse/size errors and public admission/deadline errors have only error, without code or outcome.

Media typeapplication/json
One of:
object
error
required
string

Example

{
"outcome": "not-executed"
}

Public admission cap (64 in flight), 10 second request deadline, or a route-specific unavailable read/effect. A service authority 503 may follow a binding; retain the request identity.

Media typeapplication/json
object
error
required
string
code
string
outcome
string
Allowed values: not-executed executed unknown

Example

{
"outcome": "not-executed"
}