Get started

Quickstart

Make your first LynCut API call in five minutes.

1. Get an API key

Sign in to the LynCut dashboard and create an API key under Settings → API keys. Keys are shown once — store them somewhere safe.

API keys grant full access to your account. Never expose them in client-side code or commit them to a repository.

2. Base URL

https://api.lyncut.com

For local development against the bundled Nest server, use http://localhost:4000.

3. Make your first request

List the social accounts connected to your profile:

curl "https://api.lyncut.com/v1/connections" \
  -H "x-lyncut-api-key: YOUR_API_KEY"

Responsejson

{
  "data": [
    {
      "id": "con_9f3a",
      "provider": "youtube",
      "status": "active",
      "scopes": ["youtube.upload", "youtube.readonly"],
      "expiresAt": "2026-11-02T10:41:00.000Z"
    }
  ],
  "meta": { "requestId": "req_01j..." }
}

4. Async jobs

Publishing is asynchronous. Create a job, then poll its status until it settles:

POST /v1/publishing/jobs returns a job id immediately.
GET /v1/publishing/jobs/{id} returns status: QUEUED → UPLOADING → PROCESSING → COMPLETED or FAILED.
Poll every 5–10 seconds, or pass webhook_url when creating the job to get a callback instead.

curl -X POST "https://api.lyncut.com/v1/publishing/jobs" \
  -H "x-lyncut-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "connectionId": "con_9f3a",
    "mediaKey": "upl_77kd",
    "title": "Launch teaser",
    "description": "Cut with LynCut",
    "webhookUrl": "https://example.com/hooks/lyncut"
  }'

Use POST /v1/publishing/upload-intents first to get a resumable upload URL for your export before creating the job.

Was this page helpful?

PreviousWelcome Next Authentication