Retrieval

Read File

Changed on

Read the parsed text content of a specific file.

post/api/v1/retrieval/files/read

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/retrieval/files/read
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

index_idstring required

ID of the index the file belongs to.

file_idstring required

ID of the file to read.

offsetinteger

Starting character offset.

max_lengthinteger nullable

Maximum number of characters to read from the offset.

Example request

{
  "index_id": "idx-abc123"
}

Response

Successful Response

contentstring required

Parsed text content of the file.

Changes

  • a38b684f8e1bRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status