Get files
Retrieves list of uploaded files.
Headers
Authorization
RequiredBearer <SONIOX_API_KEY>Query parameters
limit
integerMaximum number of files to return.
Default:
1000
Minimum: 1
Maximum: 1000
cursor
stringPagination cursor for the next page of results.
Response
200
List of files.
files
Requiredarray<object>List of uploaded files.
next_page_cursor
stringA pagination token that references the next page of results. When more data is available, this field contains a value to pass in the cursor parameter of a subsequent request. When null, no additional results are available.
Errors
List of files.
{
"files": [
{
"id": "84c32fc6-4fb5-4e7a-b656-b5ec70493753",
"filename": "example.mp3",
"size": 123456,
"created_at": "2024-11-26T00:00:00Z"
}
],
"next_page_cursor": "cursor_or_null"
}
Invalid request.
Error types:
invalid_cursor
: Invalid cursor parameter.
{
"status_code": 400,
"error_type": "invalid_cursor",
"message": "Invalid cursor parameter.",
"validation_errors": [],
"request_id": "3d37a3bd-5078-47ee-a369-b204e3bbedda"
}
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"
}
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"
}