getFilesStatus

The getFilesStatus endpoint retrieves the status and progress of multiple files. This endpoint requires authentication.

Endpoint

POST/api/v1/getFilesStatus

Authentication

Bearer token required. Include Authorization: Bearer <token>.

Request Body

Field	Type	Required	Description
fileIds	string[]	Yes	Array of file IDs to get status for (1-100 items).

{
  "fileIds": ["file-12345", "file-67890"]
}

Response

Success Response (200)

200Success

Returns an array of FileProcessingStatus objects:

[
  {
    "id": "string",
    "status": "Succeeded",
    "errorCode": 0,
    "progress": 100
  }
]

Response Fields

Field	Type	Description
id	string	Unique identifier for the file.
status	string	Current processing status (see possible values below).
errorCode	integer	Error code indicating success or failure reason (see possible values below).
progress	number	Processing progress (0-100).

Possible Status Values

Status	Description
Pending	File is pending processing.
InProgress	File is currently being processed.
NotFound	File was not found.
Failed	File processing failed.
Succeeded	File processing completed successfully.

Possible Error Codes

Code	Name	Description
0	None	No error - processing successful or in progress.
-1	SystemError	A system error occurred.
-2	CorruptedFile	The file is corrupted or invalid.
-3	NotEnoughVoice	Not enough voice content detected.
-4	MultiChannelVoiceNotSupported	Multi-channel voice is not supported.
-5	AudioQualityTooHigh	Audio quality is too high.
-6	AudioQualityTooLow	Audio quality is too low.
-7	UnsupportedCodec	Unsupported media codec.
-8	MultiTrackAudioNotSupported	Multi-track audio is not supported.
-9	UnknownValidationError	Unknown validation error occurred.
-10	NotEnoughCredits	Not enough credits to process the file.
-11	NotFound	File was not found.
-12	TimeOut	Processing timed out.
-13	FileSizeTooLarge	The file size exceeds the allowed limit.
-14	DurationTooShort	The file duration is below the minimum requirement.
-15	DurationTooLong	The file duration exceeds the maximum limit.
-16	UnsupportedMediaContainer	The media container is not supported.
-17	InputFileDownloadFailed	The service failed to download the input file from your provided URL (e.g., expired URL or not publicly accessible).
-18	NoAudioStreamsFound	No audio streams were found in the file.

Error Responses

400Bad Request

Returns a ValidationErrorResponse if the request is invalid (e.g., missing or empty fileIds).

401Unauthorized

Returns an OperationMessage if authentication fails.

403Forbidden

Returns an OperationMessage if access is denied.

Example Request

Example Request

{
  "fileIds": [
    "file-abc123",
    "file-def456"
  ]
}

cURL Example

cURL Example

API_BASE_URL="<api-base-url>"
ACCESS_TOKEN="<access_token>"

curl -s -X POST "$API_BASE_URL/api/v1/getFilesStatus" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
  "fileIds": [
    "file-abc123",
    "file-def456"
  ]
}'

Example Response

Example Response

[
  {
    "id": "file-abc123",
    "status": "Succeeded",
    "errorCode": 0,
    "progress": 100
  },
  {
    "id": "file-def456",
    "status": "InProgress",
    "errorCode": 0,
    "progress": 45
  }
]

Notes

• This endpoint requires an API key for authentication.
• Returns the status of multiple files in a single request.
• Use this endpoint to efficiently poll for processing progress of multiple files. The maximum supported batch size is 100 file IDs per request.