Documentation

Flikly Developer API

Integrate programmatic video workflows from your backend. Documentation is public; sign in to the dashboard to create API keys and manage webhooks.

Search coming soon — browse sections below.

Getting started

Recommended path for your first integration.

  1. Step 1

    Authentication

    API keys and server-side security

  2. Step 2

    Upload an asset

    Presigned upload and confirm

  3. Step 3

    Create a job

    Video or split jobs with idempotency

  4. Step 4

    Handle webhooks

    job.completed and job.failed

  5. Step 5

    Monitor usage

    Credits, limits, and metrics

Open quickstart guide

API reference

Endpoint guides aligned with the OpenAPI specification.

Guides

OpenAPI specification

Download the machine-readable spec or view the interactive reference.

Common questions

Who can access the API?

Developer API access is available on Team and Custom plans. Free and Creator plans are not included in V1.

How do credits work?

Credits are consumed from your existing Flikly balance. Video and split jobs debit credits according to your plan; buy more credits in main Flikly billing.

What happens when credits run out?

Job creation returns INSUFFICIENT_CREDITS. Your integration should handle this and prompt your team to add credits in the main app.

Why is URL/YouTube split input not in V1?

V1 split jobs require an uploaded source asset for predictable processing and billing. URL and YouTube inputs are planned for a future release.

V1 scope boundaries

  • Pro Limited API, social publishing, and ads API are not available
  • Split jobs from URL or YouTube — uploaded assets only
  • Official SDK packages — use OpenAPI and copy-paste examples until published
  • Auto-recharge charging is not enabled through the Developer API