Create embed session

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

POST https://api.examplary.ai/embed-sessions

Request body

application/json

flow: generate-exam

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

flow: edit-rubric

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:edit-rubric

presetsobjectrequired

Preset values for the edit-rubric flow

flow: generate-question

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-question

presetsobjectrequired

Preset values for the generate-question flow

flow: mark-answer

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:mark-answer

presetsobjectrequired

Preset values for the mark-answer flow

flow: edit-exam

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:edit-exam

presetsobjectrequired

Preset values for the edit-exam flow

flow: take-exam

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:take-exam

presetsobjectrequired

Preset values for the take-exam flow

flow: practice-space-student

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:practice-space-student

presetsobjectrequired

Preset values for the practice-space-student flow

Responses

`201`

application/json

idstringrequired

statusstringrequired

Allowed values:pendingstartedcompletedfailedcancelled

embedUrlstring· urirequired

flowstringrequired

Allowed values:generate-examgenerate-questionedit-examtake-examedit-rubricmark-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

Requirements

OAuth scopes

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