Files

Get a file

Returns a file you own or that has been shared with you, with a short-lived signed download_url once it is downloadable. This is both the upload poll (after POST /api/v1/files) and the way to fetch any file id another endpoint hands back. download_url is null until moderation_status is clean; it expires at download_url_expires_at, so re-read this endpoint rather than storing it. Safe (GET) requests are exempt from the per-day API-key quota: a poll consumes no daily slot, and only the per-minute burst limit applies. Authenticate with an API key (b4m_live_) carrying files:read, or a JWT.

get/api/v1/files/{id}

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/files/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Response

The file, and a download URL if it is downloadable.

idstring required
file_namestring required
mime_typestring required
file_sizenumber required
moderation_status'pending' | 'scanning' | 'clean' | 'blocked' | 'null' nullable required
download_urlstring nullable required
download_url_expires_atstring nullable required
created_atstring required

Example response

{
  "id": "<fileId>",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "file_size": 482133,
  "moderation_status": "clean",
  "download_url": "https://<cdn>/<key>?Signature=...",
  "download_url_expires_at": "2026-09-30T12:00:00.000Z",
  "created_at": "2026-09-29T12:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.