​
Create an API key

Before you can start using the API, you need to authenticate your requests. This is done by using an x-api-key header that links your requests to your account. To create your account and an API key, follow these steps:

  1. Sign up at the Developer Playground to create your account.
  2. Navigate to the Keys page and click create new key.
  3. Copy your API key secret and store it securely.

For security reasons, you won’t be able to view it again. If lost, you’ll need to generate a new key.

Getting started is quick and easy - you’ll be ready to use the Sync API in just a few clicks!

​
Make your first API request

With your API key in hand, you can make your first API request.

curl --request POST \
  --url https://api.sync.so/v2/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
    "model": "lipsync-1.9.0-beta",
    "input": [
      {
        "type": "video",
        "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4"
      },
      {
        "type": "audio",
        "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortaud-27623a4f-edab-4c6a-8383-871b18961a4a.wav"
      }
    ],
    "options": {
      "output_format": "mp4"
    },
    "webhookUrl": "https://your-server.com/webhook"
  }'

To get started without writing any code, you can test out the API directly from the docs by going to the Generate endpoint.