Skip to content
StudyFetch API

Embed

Refresh an embed token

Re-issues an embed token with a fresh expiry while preserving its payload (including the host-supplied userContextJwt). Powers a sliding session so a long-running embed does not die when the 1-hour token lapses. Bounded by a total session-lifetime cap and a post-expiry grace window.

OpenAPI specification
POST/api/v1/embed/refresh-token

Request

curl --globoff --request POST \
  --url 'https://api.example.com/api/v1/embed/refresh-token' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "token": "<token>"
}'

Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.

Replace https://api.example.com with the API server URL.

Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.

Request body schema or example

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "The current (possibly recently expired) embed token"
    }
  },
  "required": [
    "token"
  ]
}

Responses

200Refreshed embed token
401Token cannot be refreshed; re-authentication required