Back to Help

api

API Quickstart

Create a timeline, trigger a render, and fetch output via the public API.

Audience: developer

Prerequisites

  • Pro or Max plan with API access.
  • API key in SLIDEVIDS_API_KEY.
  • Base URL in SLIDEVIDS_API_BASE_URL.
export SLIDEVIDS_API_BASE_URL="https://api.slidevids.com/v1"
export SLIDEVIDS_API_KEY="sv_live_xxx"

1) Verify Auth

curl -s "$SLIDEVIDS_API_BASE_URL/me" \
  -H "x-api-key: $SLIDEVIDS_API_KEY"

2) Create Timeline

curl -s "$SLIDEVIDS_API_BASE_URL/timelines" \
  -X POST \
  -H "x-api-key: $SLIDEVIDS_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "title": "Q1 Update",
    "format": "landscape",
    "resolution": "1080p",
    "slides": [
      {
        "title": "Revenue Growth",
        "bullet_points": ["42% YoY", "New markets"],
        "speaker_notes": "Revenue increased significantly this quarter."
      }
    ]
  }'

Capture id as TIMELINE_ID.

3) Create Render

curl -s "$SLIDEVIDS_API_BASE_URL/renders" \
  -X POST \
  -H "x-api-key: $SLIDEVIDS_API_KEY" \
  -H "content-type: application/json" \
  -H "idempotency-key: quickstart-render-001" \
  -d '{
    "timeline_id": "tmpl_xxx",
    "output": {
      "resolution": "1080p",
      "codec": "h264",
      "format": "landscape"
    }
  }'

Capture id as RENDER_ID.

4) Poll Status

curl -s "$SLIDEVIDS_API_BASE_URL/renders/render_xxx" \
  -H "x-api-key: $SLIDEVIDS_API_KEY"

When status is completed, use output.url to download the result.

5) Register Webhook (Optional)

curl -s "$SLIDEVIDS_API_BASE_URL/webhooks" \
  -X POST \
  -H "x-api-key: $SLIDEVIDS_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "url": "https://example.com/hooks/slidevids",
    "events": ["render.completed", "render.failed"]
  }'

Continue with endpoint details: /help/api/renders