API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Documents

Create Batch Pipeline Documents

Deprecated

IReadOnlyList<CloudDocument> Pipelines.Documents.Create(DocumentCreateParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/pipelines/{pipeline_id}/documents

Paginated List Pipeline Documents

Deprecated

DocumentListPageResponse Pipelines.Documents.List(DocumentListParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/pipelines/{pipeline_id}/documents/paginated

Get Pipeline Document

Deprecated

CloudDocument Pipelines.Documents.Get(DocumentGetParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}

Delete Pipeline Document

Deprecated

Pipelines.Documents.Delete(DocumentDeleteParamsparameters, CancellationTokencancellationToken = default)

DELETE/api/v1/pipelines/{pipeline_id}/documents/{document_id}

Get Pipeline Document Status

Deprecated

ManagedIngestionStatusResponse Pipelines.Documents.GetStatus(DocumentGetStatusParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status

Sync Pipeline Document

Deprecated

JsonElement Pipelines.Documents.Sync(DocumentSyncParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/pipelines/{pipeline_id}/documents/{document_id}/sync

List Pipeline Document Chunks

Deprecated

IReadOnlyList<TextNode> Pipelines.Documents.GetChunks(DocumentGetChunksParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks

Upsert Batch Pipeline Documents

Deprecated

IReadOnlyList<CloudDocument> Pipelines.Documents.Upsert(DocumentUpsertParamsparameters, CancellationTokencancellationToken = default)

PUT/api/v1/pipelines/{pipeline_id}/documents

ModelsExpand Collapse

class CloudDocument:

Cloud document stored in S3.

required string ID

required IReadOnlyDictionary<string, JsonElement> Metadata

required string Text

IReadOnlyList<string> ExcludedEmbedMetadataKeys

IReadOnlyList<string> ExcludedLlmMetadataKeys

IReadOnlyList<Long>? PagePositions

indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1].

IReadOnlyDictionary<string, JsonElement>? StatusMetadata

class CloudDocumentCreate:

Create a new cloud document.

required IReadOnlyDictionary<string, JsonElement> Metadata

required string Text

string? ID

IReadOnlyList<string> ExcludedEmbedMetadataKeys

IReadOnlyList<string> ExcludedLlmMetadataKeys

IReadOnlyList<Long>? PagePositions

indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1].

class TextNode:

Provided for backward compatibility.

string ClassName

IReadOnlyList<Double>? Embedding

Embedding of the node.

Long? EndCharIdx

End char index of the node.

IReadOnlyList<string> ExcludedEmbedMetadataKeys

Metadata keys that are excluded from text for the embed model.

IReadOnlyList<string> ExcludedLlmMetadataKeys

Metadata keys that are excluded from text for the LLM.

IReadOnlyDictionary<string, JsonElement> ExtraInfo

A flat dictionary of metadata fields

string ID

Unique ID of the node.

string MetadataSeperator

Separator between metadata fields when converting to string.

string MetadataTemplate

Template for how metadata is formatted, with {key} and {value} placeholders.

string Mimetype

MIME type of the node content.

IReadOnlyDictionary<string, Relationship> Relationships

A mapping of relationships to other node information.

One of the following:

class RelatedNodeInfo:

required string NodeID

string ClassName

string? Hash

IReadOnlyDictionary<string, JsonElement> Metadata

NodeType? NodeType

One of the following:

"1"1

"2"2

"3"3

"4"4

"5"5

IReadOnlyList<RelatedNodeInfo>

required string NodeID

string ClassName

string? Hash

IReadOnlyDictionary<string, JsonElement> Metadata

NodeType? NodeType

One of the following:

"1"1

"2"2

"3"3

"4"4

"5"5

Long? StartCharIdx

Start char index of the node.

string Text

Text content of the node.

string TextTemplate

Template for how text is formatted, with {content} and {metadata_str} placeholders.