Media Embed

Check Embed Privacy Mode

Endpoint Description

This endpoint retrieves the privacy state of the application based on the provided token. It is primarily used to check whether the current privacy settings are secure.

Request

  • Method: GET

  • URL: {{url}}/v1/embed/privacyState?token={token}

Query Parameters

  • token (string): A unique token that identifies the user's session or request. This parameter is required for the request to be processed.

Response

The response will contain the following structure:

  • status (string): A status message indicating the result of the request.

  • data (object): An object containing the privacy state information.

  • isSecure (boolean): A boolean value indicating whether the privacy settings are secure (true or false).

Example Response

{
 "status": "",
 "data": {
 "isSecure": true
 }
}

This response indicates that the privacy settings are currently secure.

get/embed/privacyState

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/embed/privacyState
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Query parameters

tokenstring

Response

OK

statusstring

Changes

No recorded changes to this operation across all 2 revisions of this API.