Sign in
assistants

Changed on

Register the ActivityKit update token for a running voice session.

Called by the web layer inside the iOS WebView the moment ActivityKit mints a token for the Live Activity it just started, and again whenever that token rotates. Session-authenticated like its device-token sibling — the requesting user must own the assistant in the URL.

The row is replaced rather than accumulated: a token identifies one activity, and the plugin holds at most one at a time, so re-registering under the same (user, token) is an update of the same activity.

post/v1/assistants/{assistant_id}/live-activity/tokens/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token
    • API key in header Authorization

Path parameters

assistant_idstring uuid required

Request body

tokenstring required
bundle_idstring required
apns_environment'production' | 'development' required
  • production - production
  • development - development
conversation_idstring required
labelsunknown
accent_hexstring
mutedboolean

Response

tokenstring required
bundle_idstring required
apns_environment'production' | 'development' required
  • production - production
  • development - development
conversation_idstring required
labelsunknown
accent_hexstring
mutedboolean

Changes

  • c05e8c71c932Revision changes
    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

    • ○

      added the new optional request property (media type: application/json)

    • ○

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • ○

      added the new optional request property (media type: multipart/form-data)

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

  • f9f695aafcf0Revision changes
    • ○

      endpoint added