Get file
Retrieve metadata for an uploaded file.
Retrieve metadata for an uploaded file.
Headers
AuthorizationRequiredBearer <SONIOX_API_KEY>Path parameters
file_idRequiredstringFormat:
"uuid"Response
200
File metadata.
idRequiredstringUnique identifier of the file.
Format:
"uuid"filenameRequiredstringName of the file.
sizeRequiredintegerSize of the file in bytes.
created_atRequiredstringUTC timestamp indicating when the file was uploaded.
Format:
"date-time"client_reference_idstringTracking 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",
"more_info": "https://soniox.com/docs/api-reference/errors#unauthenticated"
}File not found.
Error types:
file_not_found: No file with this ID exists in the project the API key is scoped to (it may have been deleted, the ID may be wrong, or it may belong to a different project).
{
"status_code": 404,
"error_type": "file_not_found",
"message": "No file with this ID exists in your project. The file may have been deleted, the ID may be incorrect, or the file may belong to a different project. Verify the ID by listing files with GET /files.",
"validation_errors": [],
"request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda",
"more_info": "https://soniox.com/docs/api-reference/errors#file-not-found"
}Rate / capacity limit exceeded.
Error types:
limit_exceeded: The caller hit a per-minute request rate or other capacity limit. Themessagedescribes which limit was hit.
{
"status_code": 429,
"error_type": "limit_exceeded",
"message": "Requests per minute limit for file management has been exceeded for your organization.",
"validation_errors": [],
"request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda",
"more_info": "https://soniox.com/docs/api-reference/errors#limit-exceeded"
}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",
"more_info": "https://soniox.com/docs/api-reference/errors#internal-error"
}