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
sylphx events chat_profiles
Every sylphx events chat_profiles command: its argument, its flags and a run line.
The chat_profiles commands of Sylphx Events, as the CLI spells them: the same
calls as the chat_profiles API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a Chat profile and fresh presence.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles get orgs/acme/projects/shop/envs/production/chat_profiles/chat-profileGET 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.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles configure orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--terms-version | string | Accepted code of conduct version. |
--display-name | string | User-visible name. |
--allow-stranger-images | bool | Explicit opt-in; default false. |
--quiet-hours-start-utc-minute | int | UTC quiet hours, optional as a pair; start equals end disables quiet hours. |
--quiet-hours-end-utc-minute | int | UTC exclusive end, including midnight as 1440. |
#set-relationship
Changes friendship or a bilateral interaction block.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles set-relationship orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--peer-id | string | Other user's stable client id. Required. |
--action | string | request, accept, remove, block or unblock. Required. |
#list-relationships
Lists friends and pending requests with presence.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles list-relationships orgs/acme/projects/shop/envs/production/chat_profiles/chat-profileGET 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
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | Maximum results; default 50, maximum 1000. |
--page-token | string | Previous response's next_page_token. |
#report
Reports a message, image or user to the moderation queue.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles report orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--target-type | string | message, image or user. |
--target-id | string | Full message name, image SHA-256 or user id. |
--reason | string | Report reason. |
#review-media
Registers an image and its automated moderation receipt.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles review-media orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--sha256 | string | Lowercase SHA-256 digest. |
--content-uri | string | Exact existing storage URI. |
--status | string | pending registers an upload; approved or rejected is a backend moderation receipt. |
--reason | string | Administrator-only moderation reason; player status/reason are never trusted. |
#set-official-status
Verifies an official account through a distinct administrator permission.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles set-official-status orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--official | bool | Verified status; regular profile configuration never changes this flag. |
#bind-identity
Records an exact Auth-verified guest-to-platform identity link grant.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles bind-identity orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--source-client-id | string | Title-scoped guest identity whose Auth link has been verified. |
--link-receipt-id | string | Immutable receipt from the verified Auth link. |
#merge-identity
Rehomes linked guest state without discarding messages or relationships.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles merge-identity orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--source-client-id | string | Previously bound title-scoped guest identity. |
--link-receipt-id | string | Exact prior Auth-verified source/target receipt binding. |
#issue-token
Issues a bounded player capability after verified Auth token exchange.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events chat-profiles issue-token orgs/acme/projects/shop/envs/production/chat_profiles/chat-profilePOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--ttl | duration | Lifetime, 60s to 3600s; default 3600s. |