API documentation

Programmatic access uses the same endpoints as the web app. Authenticate with a bearer API key from your account page, or session cookies.

POST

Upload a clip

/v1/jobs

Multipart form with file field. Optional webhook_url.

GET

List your jobs

/v1/jobs

Returns your recent jobs with status, progress, and download links.

GET

Job status

/v1/jobs/{id}

Poll until status is finished, failed, or expired.

GET

Download clean MP4

/v1/jobs/{id}/download

Use download_url from the finished job response.

DELETE

Delete a job

/v1/jobs/{id}

Cancel pending jobs or remove completed job records.

WS

Live progress

/v1/jobs/{id}/events

WebSocket stream with status and progress updates.

Quick start

# Upload a clip
curl -X POST https://your-domain/v1/jobs \
  -H "Authorization: Bearer gck_YOUR_KEY" \
  -F "[email protected]"

# Poll status
curl https://your-domain/v1/jobs/JOB_ID \
  -H "Authorization: Bearer gck_YOUR_KEY"

# Download (use download_url from the finished job)
curl -L -o clean.mp4 "https://your-domain/v1/jobs/JOB_ID/download?token=..."

Webhooks

Pass webhook_url (HTTPS, public) as form data on upload. We POST when processing completes. Verify with header X-GenClear-Signature (HMAC-SHA256).

Interactive OpenAPI

Full schema, models, and try-it-out UI.

Open Swagger UI →

Need an API key? Generate one in Account