Audio

/api/v1/audio/retrieve

Retrieve the status or result of an audio generation request. If the audio is still being generated, returns processing status with estimated time. If complete, returns the audio data.

Authentication: This endpoint accepts either a Bearer API key or a SIGN-IN-WITH-X header for x402 wallet-based authentication. The legacy X-Sign-In-With-X header is also accepted during migration. When using x402, a 402 Payment Required response indicates insufficient balance and includes top-up instructions.

post/api/v1/audio/retrieve

Request

  • Base URL: https://api.venice.ai
  • URL: https://api.venice.ai/api/v1/audio/retrieve
  • Auth: one of:
    • HTTP bearer
    • API key in header SIGN-IN-WITH-X

Request body

modelstring required

The ID of the model used for audio generation. Voice-changer models are not supported on /api/v1/audio/retrieve or /api/v1/audio/complete; use the /api/v1/audio/voice-changer endpoints instead.

queue_idstring required

The ID of the audio generation request. Use this to poll for status and retrieve the result.

delete_media_on_completionboolean

If true, the audio media will be deleted from storage after the request is completed. If false, you can use the complete endpoint to remove the media once you have successfully downloaded the audio.

Example request

{
  "model": "elevenlabs-music",
  "queue_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Audio generation status or completed audio

status'PROCESSING' required

The status of the audio generation request.

average_execution_timenumber required

The estimated execution time of the audio generation request in milliseconds (P80).

execution_durationnumber required

The current duration of the audio generation request in milliseconds.

Example response

{
  "status": "PROCESSING",
  "average_execution_time": 20000,
  "execution_duration": 5200
}

Changes

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