Get file
Retrieve metadata for an uploaded file.
Headers
Authorization
RequiredBearer <SONIOX_API_KEY>Path parameters
file_id
RequiredstringFormat:
"uuid"
Response
200
File metadata.
id
RequiredstringUnique identifier of the file.
Format:
"uuid"
filename
RequiredstringName of the file.
size
RequiredintegerSize of the file in bytes.
created_at
RequiredstringUTC timestamp indicating when the file was uploaded.
Format:
"date-time"
client_reference_id
stringTracking 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"
}
Authentication error.
{
"status_code": 401,
"error_type": "unauthenticated",
"message": "Incorrect API key provided. You can get an API key at https://console.soniox.com",
"validation_errors": [],
"request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}
File not found.
Error types:
file_not_found
: File could not be found.
{
"status_code": 400,
"error_type": "file_not_found",
"message": "File could not be found.",
"validation_errors": [],
"request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}
Internal server error.
{
"status_code": 500,
"error_type": "internal_error",
"message": "The server encountered an error. Please try again. If the issue persists contact support@soniox.com.",
"validation_errors": [],
"request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}