Vidbyte

API documentation

Browse docs

Update a Quiz

Keys
OverviewQuickstartAuth & KeysConnectorsContext adapterImport from connectorsDeveloper guidelinesRate limitsSecurityResponse ShapeQuickhitsRoadmapsQuizzesExamsProjectsBlogContactoverview/create/batch-create/get/list/update
POSTLivePOSTFocused route reference

POST /api/v1/quizzes/update

Update a Quiz

Progressively update an existing quiz by semantic action groups instead of rebuilding it from scratch. This route is useful when your product supports iterative quiz refinement.

Manage keys
Stable public contract

Public endpoint

/api/v1/quizzes/update

Maps to

/api/sandbox/edit_quiz

What to know first

Actions can be passed as canonical slugs or grouped directives like `difficulty`, `reasoning`, `length`, `question_answers`, and `next_quiz`.

Method

POST

Send this operation to /api/v1/quizzes/update on the versioned public host.

Authentication

API key

API key via Authorization: Bearer or x-api-key

Resource model

Direct

Actions can be passed as canonical slugs or grouped directives like `difficulty`, `reasoning`, `length`, `question_answers`, and `next_quiz`.

Highlights

What this operation does

Apply progressive quiz update actions such as harder/easier, reasoning changes, and next-quiz progression.
Actions can be passed as canonical slugs or grouped directives like `difficulty`, `reasoning`, `length`, `question_answers`, and `next_quiz`.
Store the encrypted `id` returned by create and list routes exactly as returned if you need to fetch the resource again later.

Request details

Request parameters

Request parameters

These are the parameters that shape /api/v1/quizzes/update. Path parameters and request-body fields are shown together because the docs stay focused on the public route contract.

quiz_idstringRequired

Encrypted public id of the quiz to update.

actionsstring[] | objectRequired

Either an array of canonical update actions or a grouped object. Semantic phrases like `harder`, `expert`, or `next sequential topic` are normalized by the middleware.

promptstringOptional

Optional freeform semantic guidance for the update.

contentstringOptional

Optional raw source material to generate from when you want to bypass a separate upload step.

contextobject[]Optional

Optional typed context objects. Use this field to send source text, documents, prior Vidbyte resources, or content you imported from a connected provider into the request.

View supported values9 options
text

Inline plain text you want the route to read directly.

doc

A document payload or extracted document text normalized into the context layer.

pdf

A PDF payload or extracted PDF text normalized into the context layer.

quickhit

A previously generated QuickHit identified by its encrypted public id.

roadmap

A previously generated roadmap identified by its encrypted public id.

quiz

A previously generated quiz identified by its encrypted public id.

exam

A previously generated exam identified by its encrypted public id.

project

A previously generated project identified by its encrypted public id.

vidbyte_project

An alias for project-backed context in the current middleware.

Response shape

What the response contract guarantees

Public responses use the shared envelope: `success`, `id`, `message`, `data`, `token_stats`, `pricing`, and `error`.
The `id` field is always a public/encrypted identifier boundary, never a raw MongoDB `_id`.
Quiz update returns the new quiz iteration as a sanitized public resource.