Skip to content
StudyFetch API

Embed

Push context to embed instance

OpenAPI specification
POST/api/v1/embed/context/push

Request

curl --globoff --request POST \
  --url 'https://api.example.com/api/v1/embed/context/push?token=%3Ctoken%3E' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "context": "User is viewing question 1 about the lungs"
}'

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.

Parameters

tokenquery · string · required

Embed token

Request body schema or example

{
  "type": "object",
  "properties": {
    "context": {
      "type": "string",
      "description": "Context string to add",
      "example": "User is viewing question 1 about the lungs"
    }
  },
  "required": [
    "context"
  ]
}

Responses

200Context pushed successfully
400Invalid token or missing context