Vidbyte

API documentation

Get a Project

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

GET
https://vidbyte-backend.onrender.com/api/v1/projects/get/{encrypted_id}

Example request

curl https://vidbyte-backend.onrender.com/api/v1/projects/get/proj_Mx1q8Tt2 \
  -H "x-api-key: vb_live_your_api_key"

Example response

{
  "success": true,
  "id": "proj_Mx1q8Tt2",
  "data": {
    "id": "proj_Mx1q8Tt2",
    "item_type": "project",
    "title": "Backend observability project",
    "status": "active",
    "createdAt": "2026-04-10T18:00:00",
    "updatedAt": "2026-04-10T18:00:00",
    "project_data": { "generation_status": "project_completed", "project_output": { "milestones": [] } }
  }
}

Parameter information

These are the public parameters for /api/v1/projects/get/{encrypted_id}. Path parameters and request-body fields are shown together so the page stays focused on the live request contract you actually send.

encrypted_idstringRequired

The public encrypted identifier previously returned by a create or list route. Pass it back exactly as returned when you want to fetch that resource again.