Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14179784.8 KB

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

post/CreateChatToken

Request body

roomIdentifierstring required

Identifier of the room that the client is trying to access. Currently this must be an ARN.

userIdstring password required

Application-provided ID that uniquely identifies the user associated with this token. This can be any UTF-8 encoded text.

capabilitiesChatTokenCapability[]

Set of capabilities that the user is allowed to perform in the room. Default: None (the capability to view messages is implicitly included in all requests).

sessionDurationInMinutesinteger

Session duration (in minutes), after which the session expires. Default: 60 (1 hour).

attributesobject

Application-provided attributes to encode into the token and attach to a chat session. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.

Response

Success

tokenstring password

The issued client token, encrypted.

tokenExpirationTimestring date-time

Time after which the token is no longer valid and cannot be used to connect to a room. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.

sessionExpirationTimestring date-time

Time after which an end user's session is no longer valid. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.

All 17 operations