Read File

POST/api/v1/retrieval/files/read

Read the parsed text content of a specific file.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersJSONExpand Collapse

file_id: string

ID of the file to read.

index_id: string

ID of the index the file belongs to.

max_length: optional number

Maximum number of characters to read from the offset.

offset: optional number

Starting character offset.

ReturnsExpand Collapse

content: string

Parsed text content of the file.

Read File

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

{
  "content": "content"
}

Returns Examples

{
  "content": "content"
}