VidGuy Docs

Build videos faster with VidGuy

Guides and best practices for turning prompts into platform-ready videos.

Developers

VidGuy Snacks API

Use the VidGuy Snacks API to register brands, generate snack packs (up to 3 short-form video concepts at a time), optionally render them server-side, and manage credits with an API key.

Open Interactive ReferenceDownload OpenAPI JSON

Authentication

Every request uses a Bearer API key. Keys are available to Pro and Enterprise accounts.

Polling

Snack jobs are asynchronous. Poll /api/v1/jobs/{id} until status is completed or failed.

Errors

Learn the shared error shape, retry guidance, and failure categories.

Rate Limits

Understand API-key limits, quota behavior, and when to back off versus retry.

Quick start

The recommended flow is: register a brand, kick off a snack pack, then poll the returned jobId until completion.

curl -X POST https://vidguy.ai/api/v1/snacks \
  -H "Authorization: Bearer vf_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "brandId": "b7f3a8b2-1234-5678-9abc-def012345678",
    "render": true
  }'

Current endpoints

MethodPathDescription
POST/api/v1/snacksKick off a snack pack (up to 3 short-form concepts), optionally rendered.
GET/api/v1/snacksList your generated snack packs.
GET/api/v1/snacks/{id}Fetch a snack post and its manifest.
POST/api/v1/snacks/brandsRegister a brand for snack generation.
GET/api/v1/snacks/brandsList your registered brands.
GET/api/v1/snacks/brands/{id}Fetch a brand.
PATCH/api/v1/snacks/brands/{id}Update a brand.
DELETE/api/v1/snacks/brands/{id}Delete a brand (existing snack posts are preserved).
GET/api/v1/jobs/{id}Poll a snack job.
GET/api/v1/creditsGet credit balance and recent transactions.
POST/api/v1/credits/topupTop up credits with x402.