Pipelines

Upsert Pipeline

Upsert a pipeline.

Updates the pipeline if one with the same name and project already exists, otherwise creates a new one.

put/api/v1/pipelines

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

data_sink_idstring uuid nullable

Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID.

embedding_model_config_idstring uuid nullable

Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID.

statusstring nullable

Status of the pipeline deployment.

namestring required
pipeline_type'PLAYGROUND' | 'MANAGED'

Enum for representing the type of a pipeline

managed_pipeline_idstring uuid nullable

The ID of the ManagedPipeline this playground pipeline is linked to.

Example request

{
  "llama_parse_parameters": {
    "webhook_configurations": [
      {
        "webhook_url": "https://example.com/webhooks/llamacloud",
        "webhook_headers": {
          "Authorization": "Bearer sk-..."
        },
        "webhook_events": [
          "parse.success",
          "parse.error"
        ],
        "webhook_output_format": "json"
      }
    ]
  }
}

Response

Successful Response

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required
project_idstring uuid required
embedding_model_config_idstring uuid nullable

The ID of the EmbeddingModelConfig this pipeline is using.

pipeline_type'PLAYGROUND' | 'MANAGED'

Enum for representing the type of a pipeline

managed_pipeline_idstring uuid nullable

The ID of the ManagedPipeline this playground pipeline is linked to.

status'CREATED' | 'DELETING' nullable

Status of the pipeline.

Example response

{
  "llama_parse_parameters": {
    "webhook_configurations": [
      {
        "webhook_url": "https://example.com/webhooks/llamacloud",
        "webhook_headers": {
          "Authorization": "Bearer sk-..."
        },
        "webhook_events": [
          "parse.success",
          "parse.error"
        ],
        "webhook_output_format": "json"
      }
    ]
  }
}

Changes

Changed in 2 of the 33 revisions of this API.68

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new classify.running enum value to the llama_parse_parameters/anyOf[subschema #1: LlamaParseParameters]/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new sheets.cancelled enum value to the llama_parse_parameters/anyOf[subschema #1: LlamaParseParameters]/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new sheets.error enum value to the llama_parse_parameters/anyOf[subschema #1: LlamaParseParameters]/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new sheets.partial_success enum value to the llama_parse_parameters/anyOf[subschema #1: LlamaParseParameters]/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new sheets.pending enum value to the llama_parse_parameters/anyOf[subschema #1: LlamaParseParameters]/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new sheets.success enum value to the llama_parse_parameters/anyOf[subschema #1: LlamaParseParameters]/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new classify.running enum value to the request property llama_parse_parameters/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/

      request-property-enum-value-added

    • added the new sheets.cancelled enum value to the request property llama_parse_parameters/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/

      request-property-enum-value-added

    • added the new sheets.error enum value to the request property llama_parse_parameters/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/

      request-property-enum-value-added

    • added the new sheets.partial_success enum value to the request property llama_parse_parameters/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/

      request-property-enum-value-added

    • added the new sheets.pending enum value to the request property llama_parse_parameters/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/

      request-property-enum-value-added

    • added the new sheets.success enum value to the request property llama_parse_parameters/webhook_configurations/anyOf[subschema #1]/items/webhook_events/anyOf[subschema #1]/items/

      request-property-enum-value-added