Skip to main content
Media Generation is the API behind UGC. Send a prompt, and optionally reference photos or a first frame, and Appeeky renders images or short vertical videos with the model you pick. Results are saved to your Library in a UGC folder.
UGC is in beta and needs access on your account. Jobs spend media credits, not API credits.

How it works

  1. Price it. Send the request with dryRun: true to get the exact credit cost without generating.
  2. Start the job. The API answers 202 with a jobId. Credits for the job are held.
  3. Poll. GET /v1/media/jobs/:jobId until status is completed or failed.
  4. Settle. A completed job is charged. A failed job refunds the held credits.

API

These endpoints use 0 API credits.

Generate a video

Image URLs must be public https links. Response (202):

Generate images

Jobs

status is one of queued, submitted, processing, completed, failed or cancelled. When it is completed, assetIds holds the Library items and urls holds download links.
Output urls expire after a few hours. Store the assetIds or the jobId, and fetch the job again for fresh links.
credits is the held amount while a job runs, and the charged amount once it completes.

Errors


Models

GET /v1/media/models is the source of truth. Prices below are in credits during the beta and may change.

Image models

All image models work from a prompt alone or with reference photos, and make up to 4 images per request.

Video models

Credits per second at the default resolution, silent / with audio. All are image-to-video (they need imageUrl) except Veo 3.1 Reference. Higher resolutions cost more on some models. byResolution in /v1/media/models lists every rate. Per-second rates are rounded up, so dryRun gives the exact total. For example, 8 seconds of Veo 3.1 Fast with audio is 180 credits. The models list also includes the talking-avatar and lip-sync models that Studio uses to animate a photo to a voice track.