File Management

File management endpoints allow you to upload, list, download, and delete translation files. These endpoints support files up to 100MB in size and provide a simple way to manage your translation file storage.

The translation file upload response model

The upload response model contains information about the uploaded file.

Properties

  • Name
    status
    Type
    string
    Description

    The status of the upload operation.

  • Name
    file_path
    Type
    string
    Description

    The full path where the file was stored.

  • Name
    message
    Type
    string
    Description

    A message describing the result of the operation.


The translation file list response model

The list response model contains information about files in a folder.

Properties

  • Name
    files
    Type
    array
    Description

    Array of file objects in the folder.

  • Name
    folder_path
    Type
    string
    Description

    The folder path that was listed.

  • Name
    total_files
    Type
    integer
    Description

    Total number of files in the folder.

File object properties

  • Name
    file_name
    Type
    string
    Description

    The name of the file.

  • Name
    file_path
    Type
    string
    Description

    The full path to the file.

  • Name
    size
    Type
    integer
    Description

    Size of the file in bytes.

  • Name
    modified_at
    Type
    timestamp
    Description

    Timestamp of when the file was last modified.


The translation file delete response model

The delete response model confirms the file deletion.

Properties

  • Name
    status
    Type
    string
    Description

    The status of the delete operation.

  • Name
    message
    Type
    string
    Description

    A message describing the result of the operation.


POST/files/upload

Upload a translation file

This endpoint allows you to upload a file to be translated. The maximum file size is 100MB.

Required attributes

  • Name
    file
    Type
    file
    Description

    The file to upload (max 100MB).

  • Name
    folder_path
    Type
    string
    Description

    Storage location for the file.

Optional attributes

  • Name
    X-Org-Id
    Type
    string
    Description

    Organization identifier (header). If not provided, uses your default organization.

Request

POST
/v1/files/upload
curl -X POST https://api.elanlanguages.ai/v1/files/upload \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}" \
  -F "file=@/path/to/file.txt" \
  -F "folder_path=/translations"

Response

{
  "status": "success",
  "file_path": "/translations/file.txt",
  "message": "File uploaded successfully"
}

GET/v1/files/list

List translation files

This endpoint allows you to list translation files in a specific folder.

Required attributes

  • Name
    folder_path
    Type
    string
    Description

    Directory path for file listing.

Optional attributes

  • Name
    X-Org-Id
    Type
    string
    Description

    Organization identifier (header). If not provided, uses your default organization.

Request

GET
/v1/files/list
curl -G https://api.elanlanguages.ai/v1/files/list \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}" \
  -d folder_path="/translations"

Response

{
  "files": [
    {
      "file_name": "file.txt",
      "file_path": "/translations/file.txt",
      "size": 1024,
      "modified_at": "2025-12-21T10:30:00Z"
    }
  ],
  "folder_path": "/translations",
  "total_files": 1
}

GET/v1/files/download

Download a translation file

This endpoint allows you to download a translation file. File path should have URL-encoded special characters.

Required attributes

  • Name
    file_path
    Type
    string
    Description

    File location (URL encoded).

Optional attributes

  • Name
    X-Org-Id
    Type
    string
    Description

    Organization identifier (header). If not provided, uses your default organization.

Request

GET
/v1/files/download
curl -G https://api.elanlanguages.ai/v1/files/download \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}" \
  -d file_path="/translations/file.txt" \
  -o downloaded_file.txt

The file will be downloaded directly. Make sure to properly URL-encode the file_path parameter if it contains special characters.


DELETE/v1/files/delete

Delete a translation file

This endpoint allows you to delete a translation file.

Required attributes

  • Name
    file_path
    Type
    string
    Description

    File location to remove.

Optional attributes

  • Name
    X-Org-Id
    Type
    string
    Description

    Organization identifier (header). If not provided, uses your default organization.

Request

DELETE
/v1/files/delete
curl -X DELETE https://api.elanlanguages.ai/v1/files/delete \
  -H "Authorization: Bearer {token}" \
  -H "X-Org-Id: {orgId}" \
  -d file_path="/translations/file.txt"

Response

{
  "status": "success",
  "message": "File deleted successfully"
}

Was this page helpful?