Pipelines

Search Pipelines

Changed on

Search for pipelines by name, type, or project.

get/api/v1/pipelines

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
project_namestring nullable
pipeline_namestring nullable
pipeline_type'PLAYGROUND' | 'MANAGED'

Enum for representing the type of a pipeline

organization_idstring uuid nullable

Cookies

sessionstring nullable

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

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d40e17e17bd1Revision changes
    • warning

      added the new classify.running enum value to the //////// response property for the response status

    • warning

      added the new sheets.cancelled enum value to the //////// response property for the response status

    • warning

      added the new sheets.error enum value to the //////// response property for the response status

    • warning

      added the new sheets.partial_success enum value to the //////// response property for the response status

    • warning

      added the new sheets.pending enum value to the //////// response property for the response status

    • warning

      added the new sheets.success enum value to the //////// response property for the response status