On this page
Create a realtime channel
Creates a realtime channel.
Creates a realtime channel.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels - Scope
events:write - Effect
write— a successful call changes state. - Collection realtime_channels
- Query
realtime_channel_id,validate_only
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to create in. Required. |
realtime_channel_id | string | The realtime channel id, the final name segment; the server assigns one when empty. |
realtime_channel | RealtimeChannel | The realtime channel to create; only caller-writable fields are read. Required. |
validate_only | bool | Validate and return the result without writing anything. |
RealtimeChannel
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}. |
meta | ResourceMeta | Resource metadata. |
spec | RealtimeChannelSpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
RealtimeChannelSpec
| Field | Type | What it is |
|---|---|---|
publishable_ok | bool | Allow clients holding a publishable key (events:realtime:subscribe) to connect. |
history_retention | duration | How far back a cursor may resume; default 24h, at most 7d. |
chat | ChatChannelPolicy | Chat policy; when present, history is durable and membership is persistent. |
ChatChannelPolicy
| Field | Type | What it is |
|---|---|---|
kind | ChatChannelKind | Purpose of the conversation. Required. One of world, room, guild, dm, support, group. |
terms_version | string | Code of conduct version every sending member must have accepted. Required. |
messages_per_minute | int32 | Per-member sliding-minute message ceiling; default 30, maximum 600. |
participant_ids | string[] | Exact two participants for a DM or support; invited roster for groups. A player's empty group roster defaults to its creator. Backend-created groups with an empty roster admit authenticated players through join. |
title_id | string | Optional originating title for world/room/guild/support. Empty is cross-title. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}. |
uid | string | rtc_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | RealtimeChannelSpec | Desired state. Required. |
status | RealtimeChannelStatus | Observed state. Output only. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
RealtimeChannelSpec
| Field | Type | What it is |
|---|---|---|
publishable_ok | bool | Allow clients holding a publishable key (events:realtime:subscribe) to connect. |
history_retention | duration | How far back a cursor may resume; default 24h, at most 7d. |
chat | ChatChannelPolicy | Chat policy; when present, history is durable and membership is persistent. |
RealtimeChannelStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
connect_uri | string | The WebSocket URI clients connect to (wss://…/subscribe); it pushes every message after the client's cursor and carries presence. Output only. |
connection_count | int64 | Clients connected now (their presence heartbeat is fresh). Output only. |
stream_uri | string | The Server-Sent Events URI (https://…/stream), for clients that only read; it resumes from Last-Event-ID. Output only. |
ChatChannelPolicy
| Field | Type | What it is |
|---|---|---|
kind | ChatChannelKind | Purpose of the conversation. Required. One of world, room, guild, dm, support, group. |
terms_version | string | Code of conduct version every sending member must have accepted. Required. |
messages_per_minute | int32 | Per-member sliding-minute message ceiling; default 30, maximum 600. |
participant_ids | string[] | Exact two participants for a DM or support; invited roster for groups. A player's empty group roster defaults to its creator. Backend-created groups with an empty roster admit authenticated players through join. |
title_id | string | Optional originating title for world/room/guild/support. Empty is cross-title. |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.PLAN_LIMIT_REACHED— The plan's limit is reached.
Every error arrives in the body Errors describes.
Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spec":{}}'