Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Chat profiles

One platform Chat identity in a canonical shared Chat environment.

One platform Chat identity in a canonical shared Chat environment. Titles bind this same environment and client_id for shared friends, blocks, DMs and groups. A title_id is metadata, never a second identity or data authority. Unlinked guests use title-scoped client ids until a verified Auth account link merges their identity into the shared platform principal. Principal IDs are path-safe [A-Za-z0-9_.-], 1..128 bytes. Example guest.title.123 before linking, platform.authority.456 after verified linking.

Service Sylphx Events · Resource type events.sylphx.com/ChatProfile · Name pattern orgs/{org}/projects/{project}/envs/{env}/chat_profiles/{chat_profile} · Shape record

#Fields

FieldTypeWhat it is
namestringResource name; the last segment is the stable authenticated client id.
uidstringStable service-derived identifier. Output only.
metaResourceMetaResource metadata.
terms_versionstringAccepted code of conduct version, before first send; includes disclosure that images go to a third-party AI model provider through Sylphx AI Gateway. Output only.
display_namestringUser-visible name. Output only.
officialboolTrusted backend verification, never a message-supplied flag. Output only.
allow_stranger_imagesboolExplicit opt-in to images from non-mutual contacts; default false. Output only.
onlineboolFresh presence on any joined conversation. Output only.
activitystringLatest presence activity, including title and game, if the member supplied it. Output only.
quiet_hours_start_utc_minuteint32UTC quiet-hours start in minutes, 0..1439. Omit both fields to disable. Output only.
quiet_hours_end_utc_minuteint32UTC exclusive end, 0..1440; may wrap midnight. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a Chat profile and fresh presence.
POSTconfigureConfigures an authenticated Chat identity through its trusted backend.
POSTset_relationshipChanges friendship or a bilateral interaction block.
GETlist_relationshipsLists friends and pending requests with presence.
POSTreportReports a message, image or user to the moderation queue.
POSTreview_mediaRegisters an image and its automated moderation receipt.
POSTset_official_statusVerifies an official account through a distinct administrator permission.
POSTbind_identityRecords an exact Auth-verified guest-to-platform identity link grant.
POSTmerge_identityRehomes linked guest state without discarding messages or relationships.
POSTissue_tokenIssues a bounded player capability after verified Auth token exchange.

#get

Gets a Chat profile and fresh presence.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile · scope events:read · effect read · Request, response and examples

#configure

Configures an authenticated Chat identity through its trusted backend.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:configure · scope events:write · effect write · Request, response and examples

#set_relationship

Changes friendship or a bilateral interaction block.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:setRelationship · scope events:write · effect write · Request, response and examples

#list_relationships

Lists friends and pending requests with presence.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:listRelationships · scope events:read · effect read · Request, response and examples

#report

Reports a message, image or user to the moderation queue.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:report · scope events:write · effect write · Request, response and examples

#review_media

Registers an image and its automated moderation receipt.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:reviewMedia · scope events:write · effect write · Request, response and examples

#set_official_status

Verifies an official account through a distinct administrator permission.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:setOfficialStatus · scope events:chat:admin · effect write · Request, response and examples

#bind_identity

Records an exact Auth-verified guest-to-platform identity link grant.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:bindIdentity · scope events:chat:admin · effect write · Request, response and examples

#merge_identity

Rehomes linked guest state without discarding messages or relationships.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:mergeIdentity · scope events:chat:admin · effect write · Request, response and examples

#issue_token

Issues a bounded player capability after verified Auth token exchange.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:issueToken · scope events:write · effect write · Request, response and examples