Vidbyte

API documentation

Browse docs

Create a Project Draft

Keys
OverviewQuickstartAuth & KeysConnectorsContext adapterImport from connectorsDeveloper guidelinesRate limitsSecurityResponse ShapeQuickhitsRoadmapsQuizzesExamsProjectsBlogContactoverview/create/get/list/questions/generate
POSTLivePOSTFocused route reference

POST /api/v1/projects/create

Create a Project Draft

Create the initial project draft and establish the public project resource boundary. This is the first step in the staged Projects API lifecycle.

Manage keys
Stable public contract

Public endpoint

/api/v1/projects/create

Maps to

/api/sandbox/projects/create

What to know first

The public route returns the draft project id. Supporting `questions` and `generate` routes continue the project lifecycle.

Method

POST

Send this operation to /api/v1/projects/create on the versioned public host.

Authentication

API key

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

Resource model

Direct

The public route returns the draft project id. Supporting `questions` and `generate` routes continue the project lifecycle.

Highlights

What this operation does

Create a project draft from a learner topic and steering inputs.
The public route returns the draft project id. Supporting `questions` and `generate` routes continue the project lifecycle.
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/projects/create. Path parameters and request-body fields are shown together because the docs stay focused on the public route contract.

promptstringRequired

Primary user request, learning goal, or topic for generation.

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.

project_goalstringOptional

High-level outcome the learner should ship or achieve.

why_this_mattersstringOptional

Motivation, business reason, or learning importance steering.

current_levelstringOptional

Current learner level or baseline capability summary.

depth_preferencestringOptional

Desired depth or scope preference.

guidance_levelstringOptional

Preferred amount of guidance or scaffolding.

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`.
Project create returns the draft project resource boundary. Use that public id for later questions/generate/get calls.