Skip to content
LightfieldLightfield
API Reference
File

Get a file download URL

file.url(strid) -> FileURLResponse
GET/v1/files/{id}/url

Returns a temporary download URL for the file. Only available for files in COMPLETED status. Works for any retrievable file id, including files uploaded through the app.

Synced email attachments are fetched from the mail provider on first download. If the provider fails, the call returns 502 with code mail_attachment_provider_unavailable. Retry with backoff, and stop after a few attempts: some attachments fail on every request.

Required scope: files:read

Rate limit category: Read

ParametersExpand Collapse
id: str

Unique identifier of the file to download.

ReturnsExpand Collapse
class FileURLResponse: …
expires_at: str

When the download URL expires.

url: str

Temporary download URL for the file.

Get a file download URL

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
file_url_response = client.file.url(
    "id",
)
print(file_url_response.expires_at)
{
  "expiresAt": "expiresAt",
  "url": "url"
}
Returns Examples
{
  "expiresAt": "expiresAt",
  "url": "url"
}