v1

latestOpenAPI 3.0.02026-07-26213850.5 KB

generative-jobs

Create a thumbnail generation job

Experimental. Subject to change; daily caps apply and the endpoint may be temporarily disabled via a runtime kill switch. Currently the only published jobType is thumbnail (7 credits/call, charged on success and refunded on failure).

post/api/generative-jobs

Request body

jobType'thumbnail' required

The type of generative job to create. Currently the only published value is thumbnail.

sourceUristring required

URL of the source video to extract thumbnails from.

referenceImageUristring

Optional reference image URL. The thumbnail composition draws stylistic cues from this image. Upload via POST /api/upload-links with usecase: 'FreeToolMedia', then pass the returned cdnUrl here.

maskImageUristring

Optional mask image URL for inpainting.

promptstring

Optional text prompt steering the thumbnail composition.

Example request

{
  "sourceUri": "https://youtube.com/watch?v=...",
  "referenceImageUri": "https://cdn.opus.pro/uploads/.../ref.png",
  "maskImageUri": "https://cdn.opus.pro/uploads/.../mask.png",
  "prompt": "punchy red overlay, bold sans-serif title"
}

Response

jobIdstring required

The generated job ID. Use it with GET /api/generative-jobs/{jobId} to poll status and fetch results.

Example response

{
  "jobId": "thumbnail-aB3xR7nQ8z"
}