Search Files

$ llamacloud-prod beta:retrieval search

POST/api/v1/retrieval/files/search

Search for files by name.

--index-id: string

Body param: ID of the index to search within.

--organization-id: optional string

Query param

--project-id: optional string

Query param

--file-name: optional string

Body param: Exact file name to match.

--file-name-contains: optional string

Body param: Substring match on file name (case-insensitive).

--limit: optional number

Body param: Maximum number of files to return.

BetaRetrievalSearchResponse: object { files }

File search results.

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.

llamacloud-prod beta:retrieval search \
  --api-key 'My API Key' \
  --index-id idx-abc123

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

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