videos

Upload a video file (multipart)

Field file: mp4/mov/webm, streamed to disk, ≤ quota.max_bytes of the plan (3 GB free … 20 GB pro). Checks before receiving the body: 402 if the monthly video quota is reached or Content-Length exceeds the plan; free plan also refuses videos longer than 1200 s (20 min). Returns the video with status: processing; processing = probing → transcribing → detecting, usually 1-5 min for a 20 min video. Then call getVideo to read the clips.

post/api/videos

Request

  • Base URL: https://cliponit.app
  • URL: https://cliponit.app/api/videos
  • Auth: one of:
    • HTTP bearer
    • API key in cookie session
    • OAuth 2 (authorization code, authorization URL https://cliponit.app/oauth/authorize, token URL https://cliponit.app/oauth/token, scopes: clips)

Response

Created video (processing)

idstring uuid required
titlestring required
pathstring

Server-side file path (informational)

urlstring required

Source file, relative to the server, e.g. /files/uploads/<id>.mp4

thumbnail_urlstring nullable
thumbnail_pathstring nullable
size_bytesinteger required
duration_snumber nullable

Seconds, null until probed

widthinteger nullable
heightinteger nullable
status'processing' | 'ready' | 'failed' required
state'queued' | 'running' | 'ready' | 'failed' required

processing split by the job queue: queued (waiting behind other videos) or running; otherwise = status

queue_positioninteger nullable

1-based position in the processing queue while state is queued

eta_snumber nullable

Estimated seconds until ready (0.25 × (duration + durations of the videos ahead)); null when not processing

progress'downloading' | 'probing' | 'transcribing' | 'detecting' | 'demo' | 'null' nullable

Current step while processing; null when ready/failed. demo = demo copy waiting for the master

errorstring nullable

Why it failed

is_demo0 | 1 required

1 = the sample video seeded at signup (cannot be exported on the free plan)

created_atstring required
clips_countinteger required

Example response

{
  "id": "6f1c2d6e-3b1a-4c0f-9a0e-2f5d1c7b8e90"
}

Changes

No recorded changes to this operation across all 1 revision of this API.