Files

List all files

Returns a list of all stored files

get/v1/projects/{project_id}/files

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/files
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

path_prefixstring
Example:/reports/

Only files under this directory. The prefix is a path boundary, not a substring: /reports returns /reports/q1.txt and never /reports-archive/q1.txt, and / selects the whole project. A leading slash is optional and a trailing one is ignored, so reports, /reports and /reports/ are the same filter. % and _ are literal characters, not wildcards. Naming a directory under /.system/ is what includes platform-written files, which a list without this parameter leaves out.

tagsstring[]

Filter by tag pairs, written key:value (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; all must be present with exactly that value.

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

offsetinteger

Results to skip. Negative or not an integer it is 400.

Response

List of files returned successfully

totalinteger
limitinteger
offsetinteger

Example response

{
  "data": [
    {
      "id": "abc123",
      "prefix": "/images",
      "filename": "logo.png",
      "path": "/images/logo.png",
      "content_type": "application/pdf",
      "size": 1024,
      "metadata": {
        "author": "John",
        "revision": 2
      },
      "tags": {
        "team": "finance",
        "env": "prod"
      }
    }
  ]
}

Changes

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