The translation file upload response model
The upload response model contains information about the uploaded file.Properties
string
A message describing the result of the operation.
string
The name of the uploaded file.
string
The file extension type.
integer
Size of the file in bytes.
timestamp
Timestamp of when the file was uploaded.
The translation file list response model
The list response model contains information about files in a folder.Properties
array
Array of file objects in the folder.
integer
Total number of files in the folder.
string
The folder path that was listed.
The translation file delete response model
The delete response model confirms the file deletion.Properties
string
A message describing the result of the operation.
string
The path of the deleted file.
Upload a translation file
POST /files/upload
This endpoint allows you to upload a file to be translated. The maximum file size is 100MB.
Required attributes
file
required
The file to upload (max 100MB).
string
required
Storage location for the file.
Optional attributes
string
Organization identifier (header). If not provided, uses your default organization.
Response
List translation files
GET /v1/files/list
This endpoint allows you to list translation files in a specific folder.
Required attributes
string
required
Directory path for file listing.
Optional attributes
string
Organization identifier (header). If not provided, uses your default organization.
Response
Download a translation file
GET /v1/files/download
This endpoint allows you to download a translation file. File path should have URL-encoded special characters.
Required attributes
string
required
File location (URL encoded).
Optional attributes
string
Organization identifier (header). If not provided, uses your default organization.
Get file details
GET /v1/files/details
This endpoint allows you to retrieve details about a file, including analysis results such as word count and detected language. You can poll this endpoint after upload to check when background analysis completes (analysis_status changes from pending to completed).
Required attributes
string
required
File location to inspect.
Optional attributes
string
Organization identifier (header). If not provided, uses your default organization.
Response
Get a file stream URL
GET /v1/files/stream-url
This endpoint returns a short-lived presigned GET URL for streaming a file directly from S3. This is useful for media playback, as it allows the browser to range-request (and seek) large files such as videos instead of downloading the whole object through the API.
Required attributes
string
required
Unprefixed file key (the form returned by the upload endpoint).
Optional attributes
string
Organization identifier (header). If not provided, uses your default organization.
Delete a translation file
DELETE /v1/files/delete
This endpoint allows you to delete a translation file.
Required attributes
string
required
File location to remove.
Optional attributes
string
Organization identifier (header). If not provided, uses your default organization.
Response