AIaircaps
Diarizations

Delete a diarization

Cancels a queued or processing job (its error.code becomes canceled), or deletes a finished diarization and its stored data, including the uploaded file it used. Afterwards the ID returns 404.

delete/v1/diarizations/{id}

Request

  • Base URL
    https://api.aircaps.com
  • URL
    https://api.aircaps.com/v1/diarizations/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:dia_01k72p0x9h6t3b8r1n4m7q2w5e

Diarization ID.

Response

The diarization, with deleted: true. Your metadata, audio_url and webhook settings are already removed.

idstring required

Diarization ID.

object'diarization' required
status'queued' | 'processing' | 'completed' | 'error' required

queued: waiting for a processing slot. processing: being diarized. completed: result fields present. error: see error.

created_atstring date-time required

When the diarization was created (UTC).

started_atstring date-time nullable required

When processing started.

completed_atstring date-time nullable required

When the job finished (completed or error).

audio_urlstring nullable required

The submitted audio_url, if any.

file_idstring nullable required

The submitted file_id, if any.

model'aircaps-diarization-v1' required
audio_durationnumber nullable required

Audio duration in seconds, once known.

metadataobject nullable required

Your metadata, echoed back.

webhook_urlstring nullable required

Webhook target, if any.

webhook_status'pending' | 'delivered' | 'failed' | 'null' nullable required

Webhook delivery state, if webhook_url was set.

webhook_status_codeinteger nullable required

HTTP status of the last webhook delivery.

deletedtrue

Example response

{
  "id": "dia_01k72p0x9h6t3b8r1n4m7q2w5e",
  "object": "diarization",
  "audio_duration": 3600.512
}

Changes

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