Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clipping.cc/llms.txt

Use this file to discover all available pages before exploring further.

A schedule runs one of a reporter’s workflows on a cadence over a set of collections. New videos in those collections get synced and processed automatically — no manual triggering.

1. Create the schedule

curl -X POST https://api.clipping.cc/v1/reporters/rep_123/schedules \
  -H "Authorization: Bearer ck_live_…" -H "Content-Type: application/json" \
  -d '{
        "name": "Daily AI digest",
        "workflow_id": "wf_123",
        "interval_hours": 24,
        "collection_ids": ["col_123"],
        "enabled": true,
        "max_videos_per_channel": 5,
        "max_age_hours": 48
      }'
FieldMeaning
workflow_idWhich workflow to run (required).
interval_hoursHow often the schedule is due.
collection_idsCollections whose channels get synced + processed.
max_videos_per_channelCap per channel per run.
max_age_hoursIgnore videos older than this.
enabledToggle without deleting.

2. Run it now (optional)

Don’t want to wait for the cadence? Trigger immediately — it’s asynchronous:
curl -X POST https://api.clipping.cc/v1/reporters/rep_123/schedules/sch_123/run \
  -H "Authorization: Bearer ck_live_…"
{ "status": "dispatched", "schedule_id": "sch_123" }
Only one run per schedule executes at a time — triggering a second while one is running is a no-op (it won’t double-process).

3. Review runs

# recent runs for the reporter
curl "https://api.clipping.cc/v1/reporters/rep_123/schedule/runs?limit=20" \
  -H "Authorization: Bearer ck_live_…"

# one run, with enriched per-item events
curl "https://api.clipping.cc/v1/reporters/rep_123/schedule/runs/42" \
  -H "Authorization: Bearer ck_live_…"
Each scheduled run also creates executions you can list with GET /v1/reporters/{id}/executions.

Managing collections on a schedule

Attach or detach collections without recreating the schedule:
curl -X POST https://api.clipping.cc/v1/reporters/rep_123/schedules/sch_123/collections \
  -H "Authorization: Bearer ck_live_…" -H "Content-Type: application/json" \
  -d '{ "collection_id": "col_456" }'