API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Batch Pipeline Documents

Deprecated

client.Pipelines.Documents.New(ctx, pipelineID, body) (*[]CloudDocument, error)

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

Batch create documents for a pipeline.

ParametersExpand Collapse

pipelineID string

body PipelineDocumentNewParams

Body param.Field[[]CloudDocumentCreate]

Metadata map[string, any]

Text string

ID stringoptional

ExcludedEmbedMetadataKeys []stringoptional

ExcludedLlmMetadataKeys []stringoptional

PagePositions []int64optional

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

ReturnsExpand Collapse

type PipelineDocumentNewResponse []CloudDocument

ID string

Metadata map[string, any]

Text string

ExcludedEmbedMetadataKeys []stringoptional

ExcludedLlmMetadataKeys []stringoptional

PagePositions []int64optional

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

StatusMetadata map[string, any]optional

Create Batch Pipeline Documents

Go

HTTP

TypeScript

Python

Java

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  cloudDocuments, err := client.Pipelines.Documents.New(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    llamacloudprod.PipelineDocumentNewParams{
      Body: []llamacloudprod.CloudDocumentCreateParam{llamacloudprod.CloudDocumentCreateParam{
        Metadata: map[string]any{
        "foo": "bar",
        },
        Text: "text",
      }},
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", cloudDocuments)
}

200 example

[
  {
    "id": "id",
    "metadata": {
      "foo": "bar"
    },
    "text": "text",
    "excluded_embed_metadata_keys": [
      "string"
    ],
    "excluded_llm_metadata_keys": [
      "string"
    ],
    "page_positions": [
      0
    ],
    "status_metadata": {
      "foo": "bar"
    }
  }
]

Returns Examples

200 example

[
  {
    "id": "id",
    "metadata": {
      "foo": "bar"
    },
    "text": "text",
    "excluded_embed_metadata_keys": [
      "string"
    ],
    "excluded_llm_metadata_keys": [
      "string"
    ],
    "page_positions": [
      0
    ],
    "status_metadata": {
      "foo": "bar"
    }
  }
]