v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB
Retrieval

Read File

Read the parsed text content of a specific file.

post/api/v1/retrieval/files/read

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.