Skip to main content
POST
/
files
/
download
Generate bulk file download URLs
curl --request POST \
  --url https://api.uk.veridox.ai/files/download \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "file_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "files": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "download_url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "label": "<string>"
    }
  ],
  "errors": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": "<string>"
    }
  ]
}
Generate signed download URLs for multiple files in a single request. Returns partial success — URLs for accessible files plus errors for any failures. Files must be owned by the authenticated user.

​
Key Features

  • Partial Success: If some file IDs are inaccessible or invalid, the response still returns URLs for the files that succeeded, alongside per-file errors for those that failed.
  • Batch Efficiency: Download URLs for up to 25 files in a single call instead of making individual requests.
  • Short-lived URLs: Signed URLs expire after 60 minutes. Do not store them — request fresh URLs when needed.

​
Best Practices

  1. Request Fresh URLs: Always request new download URLs immediately before use. URLs expire after 60 minutes.
  2. Check Partial Errors: Inspect the errors array in the response to detect any files that could not be resolved.
  3. Stay Within Limits: A maximum of 25 file IDs are permitted per request. Split larger batches into multiple requests.
  4. Mind the Rate Limit: This endpoint is rate-limited to 20 requests per minute. Pace your requests accordingly for bulk workflows.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
file_ids
string<uuid>[]
required
Required array length: 1 - 25 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Download URLs generated successfully

​
files
object[]
required
​
errors
object[]