GET https://api.examplary.ai/embed-sessions/{id}
Path parameters
idstringrequired
Responses
200
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.