Vidbyte

API documentation

Browse docs

Projects

Keys
OverviewQuickstartAuth & KeysPricingDeveloper guidelinesRate limitsSecurityRoadmapsQuizzesProjectsBlogContactSDKsAgents

Projects API

The Projects API creates and generates a complete project artifact in one public call, then lets you list or fetch it later by its encrypted public id.

1. Create owns the complete public generation flow

Projects are more sensitive to learner context than the other resource families, so the public create route accepts the learner brief and steering inputs up front.

The public API does not expose the older questions or generate phases. Use the created project id with list and get when you need to rehydrate the generated artifact.

2. Model the family as create first, retrieval second

Use `/create` to generate and persist the project resource.

Store the returned encrypted project id in your own system.

Use `/list` and `/get` to surface saved project resources later.

3. Projects work best when the brief is grounded in the learner's real goal

Open the create endpoint

Project goal

Anchor the artifact around what the learner should actually build or ship.

Current level

Current level helps the project stay appropriately scoped instead of drifting too easy or too ambitious.

Guidance preference

Use depth and guidance controls to decide whether the project should feel scaffolded or open-ended.

create

create

Project create example

curl https://vidbyte-backend.onrender.com/api/v1/projects/create \
  -H "x-api-key: vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Design a backend observability project",
    "project_goal": "Ship something portfolio-ready",
    "current_level": "intermediate",
    "depth_preference": "deep but practical"
  }'

Endpoints

3 pages
POSTLive

/create

/api/v1/projects/create

Create and generate a complete project in a single call. Returns the finished project resource with token usage and pricing.

Open endpoint page
GETLive

/get

/api/v1/projects/get/{encrypted_id}

Fetch one project by encrypted public id. Use this route to rehydrate the current project state after draft creation or downstream generation steps.

Open endpoint page
GETLive

/list

/api/v1/projects/list

List the projects owned by the authenticated principal. This route is useful when your application needs to browse or reconcile the project inventory for an account.

Open endpoint page