Soniox
OtherAPI ReferenceSpeech-to-TextFiles

Get file

Retrieve metadata for an uploaded file.

GET
https://api.soniox.com/v1/files/{file_id}

Retrieve metadata for an uploaded file.

Headers

AuthorizationRequiredBearer <SONIOX_API_KEY>

Path parameters

file_idRequiredstring
Format: "uuid"

Response

200

File metadata.

idRequiredstring

Unique identifier of the file.

Format: "uuid"
filenameRequiredstring

Name of the file.

sizeRequiredinteger

Size of the file in bytes.

created_atRequiredstring

UTC timestamp indicating when the file was uploaded.

Format: "date-time"
client_reference_idstring

Tracking identifier string.

Errors

File metadata.

{
  "id": "84c32fc6-4fb5-4e7a-b656-b5ec70493753",
  "filename": "example.mp3",
  "size": 123456,
  "created_at": "2024-11-26T00:00:00Z",
  "client_reference_id": "some_internal_id"
}

Delete file DELETE

Permanently deletes specified file. If a transcription that has not started processing yet still references the file, that transcription fails with `file_not_found`, so delete the file only after the transcription reaches `completed` or `error`.

Get files count GET

Returns the total number of files, split by source.