Clarity

Identifier for the type of task being performed

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

Image output type.

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

• `JPG`: Best for photorealistic images with smaller file sizes (no transparency).
• `PNG`: Lossless compression, supports high quality and transparency (alpha channel).
• `WEBP`: Modern format providing superior compression and transparency support.

Compression quality of the output. Higher values preserve quality but increase file size.

Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.

Determines how the API delivers task results.

Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.

Common use cases:

• Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
• CDN integration: Upload to content delivery networks for immediate distribution.

// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

Include task cost in the response.

Image input (UUID, URL, Data URI, or Base64).

Identifier of the model to use for generation.

Factor by which to upscale the generated image. A value of 2 doubles width and height.

Text prompt describing elements to include in the generated output.

Prompt to guide what to exclude from generation. Ignored when guidance is disabled (CFGScale ≤ 1).

Random seed for reproducible generation. When not provided, a random seed is generated in the unsigned 32-bit range.

Total number of denoising steps. Higher values generally produce more detailed results but take longer.

Scheduler to use for the diffusion process.

Guidance scale representing how closely the output will resemble the prompt. Higher values produce results more aligned with the prompt.

Strength of the transformation. Lower values result in more influence from the original input.

Strength of the ControlNet influence. A value of 0 means no influence. Higher values increase the influence, and negative values can be used to steer away from the guide image.