Skip to content

Read File

$ llamacloud-prod beta:retrieval read
POST/api/v1/retrieval/files/read

Read the parsed text content of a specific file.

ParametersExpand Collapse
--file-id: string

Body param: ID of the file to read.

--index-id: string

Body param: ID of the index the file belongs to.

--organization-id: optional string

Query param

--project-id: optional string

Query param

--max-length: optional number

Body param: Maximum number of characters to read from the offset.

--offset: optional number

Body param: Starting character offset.

ReturnsExpand Collapse
BetaRetrievalReadResponse: object { content }

File read result.

content: string

Parsed text content of the file.

Read File

llamacloud-prod beta:retrieval read \
  --api-key 'My API Key' \
  --file-id file_id \
  --index-id idx-abc123
{
  "content": "content"
}
Returns Examples
{
  "content": "content"
}