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.

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

Queues a new clip job from a link (upload support coming to the API).

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"}'

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

POST /api/v1/publish

Requests publishing a clip to one or more platforms. Returns 409 until at least one platform is connected on your account — the posting-API integration is being rolled out.

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"]}'