API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Documents

Create Batch Pipeline Documents

List<CloudDocument> pipelines().documents().create(DocumentCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Paginated List Pipeline Documents

DocumentListPage pipelines().documents().list(DocumentListParamsparams = DocumentListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Get Pipeline Document

CloudDocument pipelines().documents().get(DocumentGetParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Delete Pipeline Document

pipelines().documents().delete(DocumentDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Get Pipeline Document Status

ManagedIngestionStatusResponse pipelines().documents().getStatus(DocumentGetStatusParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Sync Pipeline Document

JsonValue pipelines().documents().sync(DocumentSyncParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

List Pipeline Document Chunks

List<TextNode> pipelines().documents().getChunks(DocumentGetChunksParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Upsert Batch Pipeline Documents

List<CloudDocument> pipelines().documents().upsert(DocumentUpsertParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class CloudDocument:

Cloud document stored in S3.

String id

Metadata metadata

String text

Optional<List<String>> excludedEmbedMetadataKeys

Optional<List<String>> excludedLlmMetadataKeys

Optional<List<Long>> pagePositions

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

Optional<StatusMetadata> statusMetadata

class CloudDocumentCreate:

Create a new cloud document.

Metadata metadata

String text

Optional<String> id

Optional<List<String>> excludedEmbedMetadataKeys

Optional<List<String>> excludedLlmMetadataKeys

Optional<List<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.

Optional<String> className

Optional<List<Double>> embedding

Embedding of the node.

Optional<Long> endCharIdx

End char index of the node.

Optional<List<String>> excludedEmbedMetadataKeys

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

Optional<List<String>> excludedLlmMetadataKeys

Metadata keys that are excluded from text for the LLM.

Optional<ExtraInfo> extraInfo

A flat dictionary of metadata fields

Optional<String> id

Unique ID of the node.

Optional<String> metadataSeperator

Separator between metadata fields when converting to string.

Optional<String> metadataTemplate

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

Optional<String> mimetype

MIME type of the node content.

Optional<Relationships> relationships

A mapping of relationships to other node information.

One of the following:

class RelatedNodeInfo:

String nodeId

Optional<String> className

Optional<String> hash

Optional<Metadata> metadata

Optional<NodeType> nodeType

One of the following:

_1("1")

_2("2")

_3("3")

_4("4")

_5("5")

List<RelatedNodeInfo>

String nodeId

Optional<String> className

Optional<String> hash

Optional<Metadata> metadata

Optional<NodeType> nodeType

One of the following:

_1("1")

_2("2")

_3("3")

_4("4")

_5("5")

Optional<Long> startCharIdx

Start char index of the node.

Optional<String> text

Text content of the node.

Optional<String> textTemplate

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