Sign in
Retrieval

Find Files

Search for files by name.

post/api/v1/retrieval/files/find

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.

index_idstring required

ID of the index to search within.

file_namestring nullable

Exact file name to match.

file_name_containsstring nullable

Substring match on file name (case-insensitive).

Example request

{
  "index_id": "idx-abc123"
}

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.

Changes

Changed in 4 of the 33 revisions of this API.14