PostV1AudioSfxGenerationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/finevoice/main/json-schema/finevoice-post-v1-audio-sfx-generation-request-schema.json",
  "title": "PostV1AudioSfxGenerationRequest",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/finevoice-openapi-generated.yml#/components/schemas/PostV1AudioSfxGenerationRequest",
  "type": "object",
  "properties": {
    "prompt": {
      "type": "string",
      "description": "The prompt describing the desired sound effect."
    },
    "negative_prompt": {
      "type": "string",
      "description": "The negative prompt describing sounds to avoid."
    },
    "sourceUrl": {
      "type": "string",
      "description": "Source video or image URL for generating contextual sound effects. If provided, `sourceType` is required."
    },
    "sourceType": {
      "type": "string",
      "description": "The source media type. Supported: `image`, `video`. Required when `sourceUrl` is provided."
    },
    "duration": {
      "type": "number",
      "description": "Requested output duration in seconds. Maximum is 30 seconds."
    },
    "useAsync": {
      "type": "boolean",
      "description": "Set to `true` to process asynchronously."
    }
  }
}