Authentication

All Workshop API endpoints under /api/* require authentication. Two headers are required on every request.

Required Headers

Header Description
x-api-key Your API key. Authenticates the request.
x-org-id Your organization ID. Scopes templates, themes, and assets.
bash
curl -X POST https://api.ws.video/api/compile \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-org-id: YOUR_ORG_ID" \
  -d '{ "source": "..." }'

Getting Credentials

Workshop is in public beta. Contact us at hello@ws.video to get onboarded. You will receive an API key and org ID after onboarding.

Public Routes

Route Description
GET /health Server health check
GET /assets/:id Retrieve a previously uploaded asset

Org Scoping

The x-org-id header determines which templates, themes, and assets are visible to your request. Resources created under one org ID are not accessible to other orgs. Use separate org IDs per brand for full resource isolation.

Rate Limits

All tiers are currently limited to 10 requests per minute. This limit will be revisited after public beta. Exceeding it returns 429 Too Many Requests.

Next Steps