v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB
Beta
Files

Query Files

Query files with filtering and pagination. Deprecated: use GET /files.

post/api/v1/beta/files/query

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

page_sizeinteger nullable

The maximum number of items to return. The service may return fewer than this value. If unspecified, a default page size will be used. The maximum value is typically 1000; values above this will be coerced to the maximum.

page_tokenstring nullable

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

order_bystring nullable

A comma-separated list of fields to order by, sorted in ascending order. Use 'field_name desc' to specify descending order.

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Example response

{
  "items": [
    {
      "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "invoice.pdf",
      "external_file_id": "ext-12345",
      "file_type": "pdf",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "purpose": "parse"
    }
  ]
}