Project-based learning with single-call generation

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. Today the public create route accepts only prompt and context; the steering fields (project_goal, why_this_matters, current_level, depth_preference, guidance_level) are currently rejected with 400 Invalid Field, so write the learner's goal, level, and preferred guidance into prompt.

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

Project goal

Anchor the artifact around what the learner should actually build or ship. Say it in prompt; the project_goal field is currently rejected with 400 Invalid Field.

Current level

State the learner's level in prompt so the project stays scoped; the current_level field is currently rejected with 400 Invalid Field.

Guidance preference

Say in prompt whether the project should feel scaffolded or open-ended; depth_preference and guidance_level are currently rejected with 400 Invalid Field.

create

Project create example

bash
curl https://api.vidbyte.pro/api/v1/projects/create \ -H "x-api-key: vb_live_your_api_key" \ -H "Idempotency-Key: project-create-001" \ -H "Content-Type: application/json" \ -d '{ "prompt": "Design a portfolio-ready backend observability project for an intermediate engineer. Keep it deep but practical." }'

Endpoints

3 pages