Sync · Avatar

Sync Lipsync v2

Sync Lipsync V2 Avatar is available in the Business API catalog.

image → video
sync/sync-lipsync-v2/avatar

Capabilities

Best for

  • •Cinematic text-to-video shots
  • •Short social and ad clips
  • •Consistent multi-shot sequences
  • •Look-dev and style exploration

Not for

  • •Frame-exact rotoscoping
  • •Feature-length renders
  • •Pixel-perfect compositing
  • •Precise on-screen text

Authentication

api key header

The Pika API uses API keys to authenticate requests. Send your key in the X-API-Keyheader. Your API key is a secret. Don't expose it in browsers or other client-side code. Instead, call the API from your server. The signed-in playground uses a portal session and never sends your API key.

header
X-API-Key: YOUR_API_KEY

Endpoint

asynchronous · poll for the result

POSThttps://089e99349ace.pikalabs.app/v1/media/sync/sync-lipsync-v2/avatargenerate endpoint
GEThttps://089e99349ace.pikalabs.app/v1/media/jobs/{request_id}poll until completed
GEThttps://089e99349ace.pikalabs.app/v1/media/jobs/{request_id}/contentget the result URL

Reference Uploads

media inputs

Media inputs accept any public URL. To use a local file, POST its content_type and size_bytes to /v1/media/uploads, PUT the file to the returned upload_url, then pass the url.

upload
# 1. Request a presigned upload URL. Send the file's content
#    type and its exact size in bytes.
curl -X POST https://089e99349ace.pikalabs.app/v1/media/uploads \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content_type": "image/png", "size_bytes": 12345}'


# The response returns two URLs:
#   upload_url: a temporary URL to upload the file to. Expires in 5 minutes.
#   url:        the permanent Pika URL. Pass it to the model as the input.
# {
#   "upload_url": "https://upload.r2.pika.art/...?X-Amz-Signature=...",
#   "url": "https://cdn.pika.art/v2/media/uploads/org_abc/9f8e7d.png"
# }


# 2. Upload the file to upload_url, then pass url to the model.
curl -X PUT "<upload_url>" \
  -H "Content-Type: image/png" \
  --data-binary @input.png

Generate

POST /v1/media/sync/sync-lipsync-v2/avatar

Request

curl -X POST https://089e99349ace.pikalabs.app/v1/media/sync/sync-lipsync-v2/avatar \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "video_url": "https://example.com/reference.mp4",
  "audio_url": "https://example.com/input.mp3",
  "sound_insert_time": 0,
  "sound_start_time": 0,
  "sound_end_time": 0
}'

Response

{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "queued"
}

Request body

video_urlstringrequired
URL of the video to lip-sync.
audio_urlstringrequired
URL of the audio to sync the lips to.
sound_insert_timeinteger≥ 0default: 0
Where in the video to insert the audio, in seconds.
sound_start_timeinteger≥ 0default: 0
Where in the audio to start playback, in seconds.
sound_end_timeinteger≥ 0required
Where in the audio to stop playback, in seconds.
sound_volumenumber0 – 1
Volume of the inserted audio, from 0 to 1.
original_audio_volumenumber0 – 1
Volume of the video's original audio, from 0 to 1.

Input modes

Video urlvideo_url

Use a public URL directly, or POST { content_type, size_bytes } to /v1/media/uploads, PUT the video to the returned upload_url, then pass the url.

Audio urlaudio_url

Use a public URL directly, or POST { content_type, size_bytes } to /v1/media/uploads, PUT the audio to the returned upload_url, then pass the url.

Returns

Returns a job object with status , not the final output. Store the id from the response and poll the job until it completes.

Poll status

GET /v1/media/jobs/{request_id}

Request

curl https://089e99349ace.pikalabs.app/v1/media/jobs/{request_id} \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "status": "running"
}

Poll the job by id until it reaches a terminal state: completed or failed.

The job object

idstring
Unique identifier for the job.
statusenum
The status of the job.One of:
object
The generation output. Present once the job completes.
errorstring
If the job failed, the reason for the failure.

Get result

GET /v1/media/jobs/{request_id}/content

Request

curl https://089e99349ace.pikalabs.app/v1/media/jobs/{request_id}/content \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "url": "https://089e99349ace.pikalabs.app/v1/files/video_8f3a2c91.mp4"
}

Once the job completes, fetch a download URL for the generated media.

Returns

urlstring
Download URL for the generated file.

Errors

shared across calls

Errors use conventional HTTP status codes with a JSON body of the shape {"message": "..."}. The one exception is validation: a request body that fails validation returns 422 with a plain-text body.

StatusWhenBody
401 UnauthorizedThe API key is missing or invalid.{"message":"Invalid API key"}
403 ForbiddenThe key is not active, or the org balance cannot cover the request.{"message":"Insufficient org balance"}
404 Not FoundNo job with that id exists in your org.{"message":"media job not found"}
409 ConflictThe result was requested before the job completed, or an Idempotency-Key header was reused with a different body.{"message":"media job is not ready"}
422 Unprocessable EntityThe request body failed validation: an invalid enum value, a missing required field, a wrong type, or malformed JSON. Returned as plain text, not JSON. A schema-valid parameter combination that cannot be priced returns the same status with a JSON message.Unprocessable entity
429 Too Many RequestsOrg limit reached: requests per minute or day, or concurrent jobs. Check the Retry-After header.{"message":"rate limit exceeded: rpm"}
503 Service UnavailableThe model rail or a backend dependency is temporarily unavailable. Retry with backoff.{"message":"media dispatch unavailable"}

Pricing

only successful runs are charged

TierPrice
sync lipsync v2$3.15 / minute
default$5.23 / minute

Per-model pricing

Transparent, usage-based rates for every Sync model.

Sync Lipsync v2

Current
from $3.15 / min
Avatar

Sync Lipsync v3

$8.379 / min
Avatar