Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifacts API
- Assets API
- Auth configs API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | Resource name; the last segment is the stable authenticated client id. |
uid | string | Stable service-derived identifier. Output only. |
meta | ResourceMeta | Resource metadata. |
terms_version | string | Accepted 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_name | string | User-visible name. Output only. |
official | bool | Trusted backend verification, never a message-supplied flag. Output only. |
allow_stranger_images | bool | Explicit opt-in to images from non-mutual contacts; default false. Output only. |
online | bool | Fresh presence on any joined conversation. Output only. |
activity | string | Latest presence activity, including title and game, if the member supplied it. Output only. |
quiet_hours_start_utc_minute | int32 | UTC quiet-hours start in minutes, 0..1439. Omit both fields to disable. Output only. |
quiet_hours_end_utc_minute | int32 | UTC 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a Chat profile and fresh presence. |
POST | configure | Configures an authenticated Chat identity through its trusted backend. |
POST | set_relationship | Changes friendship or a bilateral interaction block. |
GET | list_relationships | Lists friends and pending requests with presence. |
POST | report | Reports a message, image or user to the moderation queue. |
POST | review_media | Registers an image and its automated moderation receipt. |
POST | set_official_status | Verifies an official account through a distinct administrator permission. |
POST | bind_identity | Records an exact Auth-verified guest-to-platform identity link grant. |
POST | merge_identity | Rehomes linked guest state without discarding messages or relationships. |
POST | issue_token | Issues 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