API docs by Redocly

Quietwave API (1.0.0)

Download OpenAPI specification:

API for creating jobs and processing audio or video files with QuietWave.

QuietWave API enables you to submit audio or video files for processing and manage job lifecycles.

🔐 Authentication

All endpoints require a valid x-api-key header for authentication.

📦 Data Format

Requests and responses are in JSON format.

Jobs

Create, update, and manage jobs for audio processing.

Get job status

Authorizations:
APIKeyHeader
path Parameters
id
required
string (Id)

Responses

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "status": "pending",
  • "result_url": "string",
  • "error": "string"
}

Cancel a job

Authorizations:
APIKeyHeader
path Parameters
id
required
string (Id)

Responses

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "status": "pending",
  • "result_url": "string",
  • "error": "string"
}

Process

Submit audio or video files for processing and retrieve results.

Process a file

Process a file and return a job ID

Authorizations:
APIKeyHeader
Request Body schema: application/json
required
input_url
required
string (Input Url)

URL of the input file to process

Studio Mode (boolean) or Studio Mode (null) (Studio Mode)
Default: false

Enable studio mode for advanced processing options

Callback Url (string) or Callback Url (null) (Callback Url)

Optional URL to send the job result callback

Responses

Request samples

Content type
application/json
{
  • "input_url": "string",
  • "studio_mode": false,
  • "callback_url": "string"
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "callback_url": "string"
}