Search Files

POST/api/v1/retrieval/files/search

Search for files by name.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersJSONExpand Collapse

index_id: string

ID of the index to search within.

file_name: optional string

Exact file name to match.

file_name_contains: optional string

Substring match on file name (case-insensitive).

limit: optional number

Maximum number of files to return.

ReturnsExpand Collapse

files: array of object { file_id, file_name }

Matching files with names.

file_id: string

ID of the file.

file_name: string

Display name of the file.

Search Files

curl https://api.cloud.llamaindex.ai/api/v1/retrieval/files/search \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{
          "index_id": "idx-abc123"
        }'

{
  "files": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ]
}

Returns Examples

{
  "files": [
    {
      "file_id": "file_id",
      "file_name": "file_name"
    }
  ]
}