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

Issue token on a chat profile

Issues a bounded player capability after verified Auth token exchange.

Issues a bounded player capability after verified Auth token exchange.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:issueToken
  • Scope events:write
  • Effect write — a successful call changes state.
  • Collection chat_profiles

#Request

FieldTypeWhat it is
namestringProfile in the canonical shared Chat environment. Required.
ttldurationLifetime, 60s to 3600s; default 3600s.

#Response

FieldTypeWhat it is
tokenstringPresent as Bearer on player Chat methods only. Never returned again.
expire_timetimestampCapability expiry.
client_idstringCanonical verified player principal the token represents.
profilestringProfile name in the shared Chat environment.

#Errors

  • PERMISSION_DENIED — The key lacks the method's permission.
  • INVALID_FIELD — A field failed validation.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:issueToken" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'