AI Package Actions

One route, several operations: the action field in the body selects create, regenerate, allow download or request an upload URL.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Operation to run. Absent means the legacy full package generation.

Allowed:
uuid
required

Video the resource belongs to. Required by every action.

string
enum

Resource the action applies to. Used by create, regenerate and set_download.

Allowed:
string

Language of the resource. Used by create, regenerate, upload_abstract_url, confirm_abstract and upload_abstract_image_url.

questions
array of objects

Quiz questions, when creating a Quiz by hand with action create.

questions
questions_config
object

Quiz behaviour. In the player an absent boolean counts as enabled.

mindmap
object

Mind Map tree, when creating a Mind Map by hand with action create.

mindmap_config
object

Mind Map appearance. On regenerate, an omitted field reuses the value of the previous generation.

abstract_config
object

eBook layout. Strict object: an unknown field returns 400. On regenerate, an omitted field reuses the value of the previous generation.

boolean

Turns the download of that resource on or off. Used by set_download.

boolean

Confirms the PDF was uploaded to the signed URL. Used by confirm_abstract.

string

MIME type of the file to upload. Used by upload_logo_url and upload_abstract_image_url.

string
enum

Legacy field of the full package generation, used when action is absent.

Allowed:
string

Legacy field of the full package generation, used when action is absent.

Responses

401

Missing or invalid API key.

402

Not enough AI credits.

404

Video or resource not found.

500

Internal error.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json