List Pipelines

List all pipelines in a project.

GET

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/pipelines

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/pipelines?projectId=proj-xxxxxxxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${API_KEY}" 

Possible return is similar to the following.

{
    "code": 200,
    "data": [
        {
            "pipelineId": "pipe-cf7c8f130608912949a032",
            "name": "my_doc_ingestion_pipeline",
            "type": "INGESTION",
            "createTimestamp": 1720601290000,
            "description": "A doc ingestion pipeline",
            "status": "SERVING",
            "totalUsage": {
                "embedding": 0
            },
            "functions": [
                {
                    "name": "index_my_doc",
                    "action": "INDEX_DOC",
                    "inputFields": [
                        "doc_url",
                        "doc_name"
                    ],
                    "language": "ENGLISH",
                    "chunkSize": 500,
                    "splitBy": [
                        "\n\n",
                        "\n",
                        " ",
                        ""
                    ],
                    "embedding": "zilliz/bge-base-en-v1.5"
                },
                {
                    "name": "keep_doc_info",
                    "action": "PRESERVE",
                    "inputField": "publish_year",
                    "outputField": "publish_year",
                    "fieldType": "Int16"
                }
            ],
            "clusterId": "in03-bdfdb12c2f6cae2",
            "collectionName": "doc_pipeline"
        },
        {
            "pipelineId": "pipe-22bf025b1941499b56e73f",
            "name": "my_text_ingestion_pipeline",
            "type": "INGESTION",
            "createTimestamp": 1720601012000,
            "description": "A text ingestion pipeline",
            "status": "SERVING",
            "totalUsage": {
                "embedding": 0
            },
            "functions": [
                {
                    "name": "index_my_text",
                    "action": "INDEX_TEXT",
                    "inputFields": [
                        "text_list"
                    ],
                    "language": "ENGLISH",
                    "embedding": "zilliz/bge-base-en-v1.5"
                },
                {
                    "name": "keep_text_info",
                    "action": "PRESERVE",
                    "inputField": "source",
                    "outputField": "source",
                    "fieldType": "VarChar"
                }
            ],
            "clusterId": "in03-bdfdb12c2f6cae2",
            "collectionName": "text_pipeline"
        }
    ]
}

Request

Parameters

Query parameters

Parameter Description
projectId string
The ID of the project to which this pipeline belongs.
No path parameters required
No header parameters required

Parameter	Description
projectId	string The ID of the project to which this pipeline belongs.

Request Body

No request body required

Response

Returns a list of pipelines in detail.

Response Body

{
    "code": "string",
    "data": [
        {}
    ]
}

Property	Description
code	integer Indicates whether the request succeeds. `0`: The request succeeds. Others: Some error occurs.
data	array
data[]	object
data[][opt_1]	object
data[][opt_1].pipelineId	integer A pipeline ID.
data[][opt_1].name	string Name of the pipeline.
data[][opt_1].type	string Type of the pipeline. For an ingestion pipeline, the value should be `INGESTION`.
data[][opt_1].description	string Description of the pipeline.
data[][opt_1].status	string Current status of the pipeline. If the value is other than `SERVING`, the pipeline is not working.
data[][opt_1][].functions	array Functions in the pipeline. For an ingestion pipeline, there should be only one `INDEX_DOC` function.
data[][opt_1][].functions[]	object \| object \| object \| object
data[][opt_1][].functions[].[opt_1]	object
data[][opt_1][].functions[].[opt_1].name	string Name of the function to create.
data[][opt_1][].functions[].[opt_1].action	string Type of the function to create. For an ingestion pipeline, possible values are `INDEX_DOC` and `PRESERVE`.
data[][opt_1][].functions[].[opt_1][].inputFields	array Names the fields according to your needs. In an `INDEX_TEXT` function of an ingestion pipeline, use them for the user-provided texts.
data[][opt_1][].functions[].[opt_1][].inputFields[]	string An input field.
data[][opt_1][].functions[].[opt_1].langauge	string Language that your document is in. Possible values are `english` or `chinese`. The parameter applies only to ingestion pipelines.
data[][opt_1][].functions[].[opt_1].embedding	string Name of the embedding model in use.
data[][opt_1][].functions[].[opt_2]	object
data[][opt_1][].functions[].[opt_2].name	string Name of the function to create.
data[][opt_1][].functions[].[opt_2].action	string Type of the function to create. For an ingestion pipeline, possible values are `INDEX_DOC` and `PRESERVE`.
data[][opt_1][].functions[].[opt_2].inputField	string Name the field according to your needs. In an `INDEX_DOC` function of an ingestion pipeline, use it for pre-signed document URLs in GCS or AWS S3 buckets.
data[][opt_1][].functions[].[opt_2].langauge	string Language that your document is in. Possible values are `english` or `chinese`. The parameter applies only to ingestion pipelines.
data[][opt_1][].functions[].[opt_2].chunkSize	integer The maximum size of a splitted document segment.
data[][opt_1][].functions[].[opt_2].embedding	string Name of the embedding model in use.
data[][opt_1][].functions[].[opt_2].splitBy	string The splitters that Zilliz Cloud uses to split the specified docs.
data[][opt_1][].functions[].[opt_3]	object
data[][opt_1][].functions[].[opt_3].name	string Name of the function to create.
data[][opt_1][].functions[].[opt_3].action	string Type of the function to create. For an ingestion pipeline, possible values are `INDEX_DOC` and `PRESERVE`.
data[][opt_1][].functions[].[opt_3][].inputFields	array Names the fields according to your needs. In an `INDEX_IMAGE` function of an ingestion pipeline: `image_url` stands for pre-signed image URLs in GCS or AWS S3 buckets, and `image_id` stands for the image ID.
data[][opt_1][].functions[].[opt_3][].inputFields[]	string An input field.
data[][opt_1][].functions[].[opt_3].embedding	string Name of the embedding model in use.
data[][opt_1][].functions[].[opt_4]	object
data[][opt_1][].functions[].[opt_4].name	string Name of the function to create.
data[][opt_1][].functions[].[opt_4].action	string Type of the function to create. For an ingestion pipeline, possible values are `INDEX_DOC` and `PRESERVE`.
data[][opt_1][].functions[].[opt_4].inputField	string Name the field according to your needs. In a preserve function of an ingestion pipeline, Zilliz Cloud uses the value as the name of a field in the collection to create.
data[][opt_1][].functions[].[opt_4].outputField	string Name of the output field. The value should be the same as that of `input_field`.
data[][opt_1][].functions[].[opt_4].fieldType	string Data type of the field to create in the target collection. Possible values are `BOOL`, `INT8`, `INT16`, `INT32`, `INT64`, `FLOAT`, `DOUBLE`, and `VARCHAR`.
data[][opt_1].clusterID	string The target cluster to which the pipeline applies.
data[][opt_1].collectionName	string The target collection to which the pipeline applies.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. `0`: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.

Example​

Request​

Parameters​

Request Body​

Response​

Response Body​

Error Response​