API Reference

OptimaClip's REST API lets you trigger clip jobs, read clip data, and request publishing from your own code, Zapier, n8n, or an AI agent — without opening the dashboard. Requires the Creator plan or higher.

Creator's Basic access covers reading your clips (GET /api/v1/clips, GET /api/v1/clips/:id) and publishing already-rendered ones (POST /api/v1/publish). Submitting brand-new video jobs via the API (POST /api/v1/clips) needs Full access, on the Agency plan.

Authentication

Generate a key from Dashboard → Developer / API. Send it as a Bearer token on every request.

Authorization: Bearer oc_live_xxxxxxxxxxxxxxxxxxxx

GET /api/v1/clips

Returns up to 50 of your most recent clips.

curl https://optimaclip.com/api/v1/clips \
  -H "Authorization: Bearer oc_live_..."

# 200 OK
{ "data": [ { "id": "...", "title": "...", "viralityScore": 92, ... } ] }

GET /api/v1/clips/:id

Returns a single clip by ID.

curl https://optimaclip.com/api/v1/clips/clx123... \
  -H "Authorization: Bearer oc_live_..."

POST /api/v1/clips

Requires Full API access (Agency plan) — returns 403 on a Creator-plan (Basic) key. Queues a new clip job from a link (upload support coming to the API). Optional captionsEnabled (boolean, defaults to true) controls whether captions get burned in.

rightsConfirmed (boolean, required, must be true) confirms that you own the video/link you're submitting, or are otherwise authorized to use it — the same confirmation the dashboard requires via a checkbox on the New Clip Job form. Omitting it or sending false returns 400. See our Terms and DMCA Policy— the account whose API key was used is solely responsible for content submitted this way.

curl -X POST https://optimaclip.com/api/v1/clips \
  -H "Authorization: Bearer oc_live_..." \
  -H "Content-Type: application/json" \
  -d '{"sourceLabel": "https://youtube.com/watch?v=...", "sourceType": "link", "captionsEnabled": true, "rightsConfirmed": true}'

# 201 Created
{ "data": { "id": "...", "status": "PENDING_PIPELINE", ... } }

POST /api/v1/publish

Publishes a rendered clip to one or more connected platforms. Returns 409if the clip isn't rendered yet or none of the requested platforms are connected on your account.

curl -X POST https://optimaclip.com/api/v1/publish \
  -H "Authorization: Bearer oc_live_..." \
  -H "Content-Type: application/json" \
  -d '{"clipId": "clx123...", "platforms": ["YOUTUBE", "TIKTOK"]}'