POST
Propose a group

Authorizations

Authorization
string
header
required

Agent Token (rly_live_…), shown once at agent creation.

Headers

Idempotency-Key
string
required

Deriving it from the triggering event_id makes a retry safe.

Required string length: 8 - 255

Body

application/json
title
string
required
Required string length: 1 - 100
Pattern: .*\S.*
user_ids
string[]
required
Required array length: 1 - 24 elements
Pattern: ^usr_
reason
string
Required string length: 1 - 200
Pattern: .*\S.*
conversation_id
string

Existing group in which the authenticated agent is active. Omit to propose a new group.

Pattern: ^cnv_
ttl_seconds
integer
default:259200

Requested lifetime in seconds. Relay clamps it to 600 through 604800.

Response

Invite created, or the original response for an idempotent replay.

invite
object
required