---
title: "Find Files"
method: POST
path: "/api/v1/retrieval/files/find"
tags: ["Retrieval"]
---

# Find Files

`POST /api/v1/retrieval/files/find`

Search for files by name.

## Query parameters

- `project_id` string, uuid, nullable
- `organization_id` string, uuid, nullable

## Cookies

- `session` string, nullable

## Request body

- FileFindParams — Search for files by name.
  - `page_size` integer, 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_token` string, nullable — A page token, received from a previous list call. Provide this to retrieve the subsequent page.
  - `index_id` string, required — ID of the index to search within.
  - `file_name` string, nullable — Exact file name to match.
  - `file_name_contains` string, nullable — Substring match on file name (case-insensitive).

## Response `200`

Successful Response

- FileFindResult — Paginated file find results.
  - `items` FileFindEntry[], required — The list of items.
    - `file_id` string, required — ID of the file.
    - `file_name` string, required — Display name of the file.
  - `next_page_token` string, 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_size` integer, 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.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/run-llama/apis/llama-platform.md) · [All operations](https://skmtc.net/run-llama/apis/llama-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/run-llama/llama-platform/versions/b17341164de9/schema)
