Quickstart

This guide renders a short motion-graphics video through the Workshop API.

Prerequisites

You need:

  • A Workshop base URL, for example https://demo.ws.video
  • An API key for your org
bash
export WORKSHOP_URL="https://demo.ws.video"
export WORKSHOP_API_KEY="sk_live_..."

Step 1: Check Health

The public health route does not require auth.

bash
curl "$WORKSHOP_URL/health"
json
{ "status": "ok", "version": "1.0.0" }

Step 2: Compile Source

Compilation validates the .ws source and returns a RenderGraph. This is the fastest way to catch errors before rendering.

bash
curl -X POST "$WORKSHOP_URL/api/compile" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $WORKSHOP_API_KEY" \
  -d '{
    "source": "Film "Hello World"
  mood: precision

Scene "Intro"
  show "Hello, Workshop."
    size: hero
    enter: rise"
  }'

A successful response includes renderGraph and diagnostics.

Step 3: Queue A Render

bash
curl -X POST "$WORKSHOP_URL/api/render" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $WORKSHOP_API_KEY" \
  -d '{
    "source": "Film "Hello World"
  mood: precision

Scene "Intro"
  show "Hello, Workshop."
    size: hero
    enter: rise",
    "engine": "native"
  }'
json
{
  "jobId": "job_abc123",
  "status": "queued",
  "message": "Render queued. Poll GET /api/render/job_abc123 for status."
}

Step 4: Poll Status

bash
curl "$WORKSHOP_URL/api/render/job_abc123" \
  -H "x-api-key: $WORKSHOP_API_KEY"

Wait until status is complete.

Step 5: Download The MP4

bash
curl -L -o hello-workshop.mp4 "$WORKSHOP_URL/api/video/job_abc123" \
  -H "x-api-key: $WORKSHOP_API_KEY"

You now have a rendered motion-graphics video produced from .ws source.

What Happened

Workshop did not ask a generative video model to invent the whole artifact. It compiled readable source into a deterministic RenderGraph, then rendered that graph into MP4. That is the production loop you can automate, review, and scale.

Next Steps