UGC Ad Options API

Keyword target: UGC ad options API

The UGC ad options endpoint is the authoritative, authenticated list of accepted values for a UGC request. Use it before building controls or validating customer input so a reseller integration can follow newly added enum values without hardcoding a stale list.

1. Call the endpoint with the same server-side API key used for generation.
2. Populate selectors from the returned arrays and preserve the exact values.
3. Send the selected values with an owned uploadId to POST /api/v1/ugc-ad.

Working example

Set REVIRAL_API_KEY only in your server environment, then run this request with values valid for your account.

curl "https://reviral.ai/api/v1/ugc-ad/options" \
  -H "Authorization: Bearer $REVIRAL_API_KEY"

{
  "data": {
    "angles": [
      {
        "value": "testimonial",
        "label": "Honest review"
      },
      {
        "value": "problem-solution",
        "label": "Problem to solution"
      }
    ],
    "creators": [
      {
        "value": "lifestyle",
        "label": "Lifestyle creator"
      },
      {
        "value": "tech",
        "label": "Tech / gadget creator"
      }
    ],
    "scenes": [
      {
        "value": "home",
        "label": "Home / bathroom"
      },
      {
        "value": "desk",
        "label": "Office desk"
      }
    ],
    "modes": [
      "i2v",
      "r2v"
    ],
    "durationsSec": [
      15,
      30,
      45,
      60
    ],
    "resolutions": [
      "480p",
      "720p",
      "1080p"
    ],
    "aspectRatios": [
      "9:16",
      "16:9",
      "1:1"
    ]
  }
}

Frequently asked questions

Should my application hardcode UGC enum values?

Prefer reading this endpoint and caching its response. That keeps validation aligned when additive options are released.

Does reading UGC options start a job or charge credits?

No. It returns configuration values only and does not start or debit a render.

Do invalid query parameters get ignored?

No. Send the endpoint without query parameters; unsupported parameters are rejected.

List UGC ad options

Lists every accepted angle, creator, scene, mode, duration, resolution, and aspect value.

Authentication: Bearer API key required

curl "https://reviral.ai/api/v1/ugc-ad/options" \
  -H "Authorization: Bearer $REVIRAL_API_KEY"