API Reference

Beta

Retrieval

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Read File

RetrievalReadResponse Beta.Retrieval.Read(RetrievalReadParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/retrieval/files/read

Read the parsed text content of a specific file.

ParametersExpand Collapse

RetrievalReadParams parameters

required string fileID

Body param: ID of the file to read.

required string indexID

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

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

Long? maxLength

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

Long offset

Body param: Starting character offset.

ReturnsExpand Collapse

class RetrievalReadResponse:

File read result.

required string Content

Parsed text content of the file.

Read File

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

RetrievalReadParams parameters = new()
{
    FileID = "file_id",
    IndexID = "idx-abc123",
};

var response = await client.Beta.Retrieval.Read(parameters);

Console.WriteLine(response);

200 example

{
  "content": "content"
}

Returns Examples

200 example

{
  "content": "content"
}