Skip to content
StudyFetch API

Embed

Process embed interaction

OpenAPI specification
POST/api/v1/embed/component/{componentId}/interact

Request

curl --globoff --request POST \
  --url 'https://api.example.com/api/v1/embed/component/%3CcomponentId%3E/interact?token=%3Ctoken%3E' \
  --header 'x-embed-token: <x-embed-token>' \
  --header 'Content-Type: application/json' \
  --data-raw '"<request_body>"'

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

componentIdpath · string · required

Component ID or MongoDB _id

tokenquery · string · required

Embed token

x-embed-tokenheader · string · required

Request body schema or example

{
  "type": "string"
}

Responses

200Interaction processed
400Invalid request