Vidbyte

API documentation

Make your first request

This quickstart only covers the minimum setup you need to reach a successful API call: create a key, add API balance, and use that key in an example request.

1: Create your key

Open the API settings page, create a key, and copy it somewhere secure immediately. Vidbyte only shows the plaintext key once, so move it into your secret store or local environment before you continue.

2: Add API balance

Vidbyte API usage is funded separately from subscriptions through the API balance checkout flow on the API settings page. Add balance there so your first request can execute successfully.

3: Send a request

Quickhits are the simplest first request because the payload is small and the response is easy to inspect. Replace the placeholder key with the live key you created in settings and send the request below against the public API host.

Example curl request

Quickhits create request

curl https://vidbyte.pro/api/api/v1/quickhits/create \
  -H "Authorization: Bearer vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Explain event sourcing to a CRUD engineer",
    "mode": "broad",
    "context": [
      { "type": "text", "label": "audience", "text": "Senior backend engineers" }
    ]
  }'

More examples

After the first request succeeds, you can use the same API key and API balance on the other route families. The examples below show the same auth pattern on a retrieval route and a second generation route.

Example curl request

List Quickhits

curl https://vidbyte.pro/api/api/v1/quickhits/list \
  -H "Authorization: Bearer vb_live_your_api_key"

curl https://vidbyte.pro/api/api/v1/roadmaps/create \
  -H "Authorization: Bearer vb_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Create a backend API platform roadmap",
    "experience": "Intermediate",
    "timeline": "3 Months"
  }'