Recipes

Create a product UGC video

Changed on

Generate a vertical user-generated content ad from a character image, product image, product details, and optional creative direction.

post/v1/recipes/product_ugc

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/recipes/product_ugc
  • Auth
    HTTP bearer

Headers

X-Runway-Version'2024-11-06' required

The version of the RunwayML API being used. You can read more about versioning here.

Request body

version'2026-06' | 'unsafe-latest' required

Workflow version. Use a dated version (e.g. "2026-06") to pin behavior, or "unsafe-latest" to track the newest stable version (may break without notice).

productInfostring

Product details and creative brief - what the product is, key benefits, and any specifics the script should reference.

userConceptstring

Optional creative direction for the UGC video - tone, voice register, specific message, or an entire dialog script.

durationinteger

Duration of the output video in seconds (4-15). Defaults to 15 seconds.

ratio'720:1280' | '1080:1920'

The resolution of the output video.

audioboolean

Whether to generate audio for the video.

Example request

{
  "characterImage": {
    "uri": "https://example.com/image.jpg"
  },
  "productImage": {
    "uri": "https://example.com/image.jpg"
  }
}

Response

The task that was created.

idstring uuid required

The ID of the task that was created. Use this to retrieve the task later.

Changes

  • ef7e1923afafRevision changes
    • info

      added the optional property to the response with the status

  • 73a12c23285cRevision changes
    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status