files

List files

List all files for the authenticated user.

Args: pagination: The pagination options

Returns: A list of files belonging to the user.

get/v1/files

Request

Base URL
https://api.mixedbread.com
URL
https://api.mixedbread.com/v1/files
Auth
HTTP bearer

Query parameters

limitinteger

Maximum number of items to return per page (1-100)

Example:10

afterstring nullable

Cursor for forward pagination - get items after this position. Use last_cursor from previous response.

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==

beforestring nullable

Cursor for backward pagination - get items before this position. Use first_cursor from previous response.

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==

include_totalboolean

Whether to include total count in response (expensive operation)

qstring nullable

Search query for fuzzy matching over name and description fields

Response

A list of files for the user

object'list'

The object type of the response

Example response

{
  "pagination": {
    "has_more": true,
    "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==",
    "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMFQyMzo1OTo1OS4wMDBaIiwiaWQiOiJ4eXo3ODkifQ==",
    "total": 42
  },
  "data": [
    {
      "id": "file_abc123",
      "filename": "document.pdf",
      "bytes": 1024,
      "mime_type": "application/pdf",
      "version": 1
    }
  ]
}

Changes

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