Create embed session

POSThttps://api.examplary.ai/embed-sessions

Create a new embed session. This allows you to embed the exam generation flow into your own application.

Request body

actorstringrequired

The user ID for whom the embed session is created

themeobjectrequired

UI options for the embed session

metadataobject

Additional key-value metadata

returnUrlstring· uri

Optional redirect URL after completion

allowedOriginstring· uri

Optional allowed origin for postMessage events

flowstringrequired

Allowed values:generate-exam

presetsobjectrequired

Preset values for the generate-exam flow

Responses

`201`

idstringrequired

statusstringrequired

Allowed values:pendingstartedcompletedfailedcancelled

embedUrlstring· urirequired

flowstringrequired

Allowed values:generate-examgenerate-questionedit-examtake-examedit-rubricgrade-answermark-answerpractice-space-student

actorstringrequired

enabledResponseModesarray string[]required

createdAtstring· date-time· pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$required

expiresAtstring· date-time· pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$required

createdBystringrequired

presetsanyrequired

outputsobjectrequired

themeobjectrequired

metadataobjectrequired

`400` — Validation Error

successbooleanrequired

Allowed values:false

errorarray any[]required

dataanyrequired

Requirements

OAuth scopes

This endpoint requires the embed-sessions:manage scope to be present.