Jobs

Start a tool on files

The body is the tool's ID and its input in snake_case, such as {"tool": "remove_noise", "file_id": "file_8Kc2QmP4", "idempotency_key": "<a new UUID>"}. The price is reserved now and charged only if the job succeeds. Add max_credits to cap it, or "free": true for the free part. The Idempotency-Key header works in place of idempotency_key.

post/api/v1/jobs

Request

  • Base URL: https://audo.ai
  • URL: https://audo.ai/api/v1/jobs
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-audo.session_token

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

OK

idstring required
tool'remove_noise' | 'enhance_voice' | 'transcribe_audio' | 'align_script' | 'cut_audio' | 'remove_silence' | 'adjust_loudness' | 'convert_audio' | 'join_audio' | 'replace_audio' | 'analyze_audio' | 'remove_fillers' | 'level_speakers' | 'mix_tracks' required
status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'held' required
progressinteger required

How much of the job is done, from 0 to 100. It never goes down, and its first part is the time a job usually takes to start

stage'queued' | 'preparing' | 'processing' | 'finishing' | 'succeeded' | 'failed' | 'cancelled' | 'held' required

Where the job is: queued (not started yet, perhaps behind the account's other running jobs), preparing (getting the file ready), processing (the tool's work), finishing (saving the result), then succeeded, failed, or cancelled; or held (waiting for payment: see finishUrl)

estimatedSecondsLeftinteger nullable required

About how many seconds the job has left, from the file's length and how fast the tool runs, refined as it goes. A rough guide. Null while it's queued, while Audo is busy (waitingForWorker), and once it has ended

waitingForWorkerboolean required

True while a running job has waited in line longer than a start usually takes: Audo is busy, and the job carries on as soon as there's room. A free job also waits behind paid ones, so it can wait longer; jobs with credits go first

inputFileIdsstring[] required

The main input first

outputFileIdsstring[] required

The main output first, once the job succeeds

freeboolean required

A free job processes only the first part of its input, at no cost

processedSecondsnumber required

How much of the input the job processes

quotedCreditsinteger required
chargedCreditsinteger nullable required

Set when the job succeeds

resultobject nullable required

The tool's details, such as loudness before and after

createdAtstring required

ISO 8601 time

startedAtstring nullable required

ISO 8601 time

finishedAtstring nullable required

ISO 8601 time

finishUrlstring nullable

A job held for payment: the page where the whole file can run, or null once its files are gone

Changes

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