Text to SFX

Create async job

Start an async text-to-sfx generation job. Returns immediately with a job_id. Poll the job status endpoint until status is succeeded or errored.

post/v2/text-to-sfx/v1.5/jobs

Request

  • Base URL: https://api.mirelo.ai
  • URL: https://api.mirelo.ai/v2/text-to-sfx/v1.5/jobs
  • Auth: HTTP bearer

Request body

promptstring required

Text description of the sound to generate

duration_msnumber

Duration in milliseconds (max 10000ms). Defaults to 10000.

num_samplesinteger

Number of audio variants to generate

Example request

{
  "prompt": "thunder rumbling in the distance"
}

Response

Job accepted

job_idstring uuid required

Unique identifier for the async job

job_urlstring required

Relative URL to poll for job status, e.g. /v2/text-to-sfx/{version}/jobs/{job_id}. Append to your API base URL to form the full polling URL.

estimated_msinteger required

Estimated completion time in milliseconds

estimated_completion_atstring date-time required

ISO 8601 estimated completion timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.