Product demos from one API call

Quick start

1. Create an account and open Profile → API keys. Create a key; it is shown once. You can have up to five.
2. Start a demo with POST /v1/demos. You get its id back at once (HTTP 202).
3. Get the result with GET /v1/demos/{id}, or let DemoVisor call your webhook when it is done. A demo usually takes a few minutes.

Create a demo

curl -X POST https://demovisor.com/v1/demos \
  -H "X-API-Key: dv_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-product.com",
    "goal": "Show how a new user creates their first project",
    "format": "Product explainer",
    "webhook_url": "https://your-app.com/hooks/demovisor"
  }'

Field	Required	What it does
url	Yes	The public page where the workflow starts (http or https).
goal	No	What the video should show, in plain words.
name	No	The product name to use in the video.
format	No	Product explainer (default), Feature demo, Tutorial or Social clip.
webhook_url	No	A public https address that receives the finished demo once, by POST.

Check status and get the files

curl https://demovisor.com/v1/demos/DEMO_ID -H "X-API-Key: dv_your_key"

status is queued, running, succeeded, failed or canceled, with progress (0–100) and a readable message. When it succeeds:

{
  "id": "39323c95-…",
  "status": "succeeded",
  "progress": 100,
  "message": "Your video and content kit are ready.",
  "url": "https://your-product.com",
  "format": "Product explainer",
  "result": {
    "share_url": "https://demovisor.com/share/…",
    "video_url": "https://demovisor.com/share/…/explainer.mp4",
    "poster_url": "https://demovisor.com/share/…/scene-01.png",
    "deck_url": "https://demovisor.com/share/…/product-deck.pptx",
    "guide_url": "https://demovisor.com/share/…/guide.pdf",
    "captions_url": "https://demovisor.com/share/…/captions.srt",
    "transcript": "Your product turns …",
    "steps": [
      { "title": "Create a project", "narration": "…", "actions": ["click New project"] }
    ]
  }
}

File links go through the demo's share link, so they work without your key. Failed demos include an error in plain words.

Webhooks

If you pass webhook_url, DemoVisor sends the same JSON as GET /v1/demos/{id} by POST when the demo ends. It is sent once, without retries or a signature, so treat it as a notification and confirm with a GET.

Authentication and limits

• Send your key as X-API-Key: dv_… or Authorization: Bearer dv_…. Only a hash of the key is stored.
• Each demo uses one generation of your plan, with the same narration allowance and watermark as the app. See plans.
• Up to 120 requests a minute per account. One video is made at a time per account.
• Only public sites can be recorded. Pages behind a bot check (such as Cloudflare's challenge) cannot.

OpenAPI

The full description is at /openapi.json (OpenAPI 3.1), ready for code generators and agent tools.

Build demos into your product

Start free, create a key and make your first demo in minutes.

Get an API key See examples