Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.opus.pro/llms.txt

Use this file to discover all available pages before exploring further.

jobType
enum<string>
required

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

Available options:
thumbnail
sourceUri
string
required

URL of the source video to extract thumbnails from.

Example:

"https://youtube.com/watch?v=..."

referenceImageUri
string

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.

Example:

"https://cdn.opus.pro/uploads/.../ref.png"

maskImageUri
string

Optional mask image URL for inpainting.

Example:

"https://cdn.opus.pro/uploads/.../mask.png"

prompt
string

Optional text prompt steering the thumbnail composition.

Example:

"punchy red overlay, bold sans-serif title"