Files

List files

Lists the files you own, newest first, excluding archived and deleted ones. Files shared with you are not listed, though GET /api/v1/files/{id} resolves them by id: listing shares would need access checks that cannot be paged by cursor. Items carry no download_url; fetch a file by id for its bytes. search keeps only files whose name contains it, ignoring case; results stay newest first with no relevance ranking. Cursor-paginated (see the pagination convention): pass next_cursor back as cursor, with the same search, until it is null. Safe (GET) requests are exempt from the per-day API-key quota; only the per-minute burst limit applies. Authenticate with an API key (b4m_live_) carrying files:read, or a JWT.

get/api/v1/files

Request

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

Query parameters

limitinteger
cursorstring
searchstring

Response

One page of files, newest first by id.

next_cursorstring nullable required

Example response

{
  "data": [
    {
      "id": "<fileId>",
      "file_name": "reference.png",
      "mime_type": "image/png",
      "file_size": 482133,
      "moderation_status": "clean",
      "created_at": "2026-09-29T12:00:00.000Z"
    }
  ],
  "next_cursor": null
}

Changes

No recorded changes to this operation across all 2 revisions of this API.