GET
/
pipelines
const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
fetch(`https://api.lume.ai/pipelines`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.catch(err => console.error(err));
{
    "items": [
        {
            "id": "9sh74hf8-8sh8-9sj7-2183-d83h787hdw2a",
            "created_at": "2024-02-28T20:37:28.000151Z",
            "name": "ordered_test_2",
            "description": "ordered_test_2",
            "target_schema": {
                "type": "object",
                "properties": {
                    "first_name": {
                        "type": "string",
                        "description": "The first name of the user"
                    },
                    "last_name": {
                        "type": "string",
                        "description": "The last name of the user"
                    }
                },
                "required": [
                    "first_name",
                    "last_name"
                ]
            },
            "source_schema": null,
            "updated_at": null
        }
    ],
    "total": 1,
    "page": 1,
    "size": 50,
    "pages": 1
}

Gets all pipelines.

See the Pipeline Guide to learn more.

const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
fetch(`https://api.lume.ai/pipelines`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.catch(err => console.error(err));
{
    "items": [
        {
            "id": "9sh74hf8-8sh8-9sj7-2183-d83h787hdw2a",
            "created_at": "2024-02-28T20:37:28.000151Z",
            "name": "ordered_test_2",
            "description": "ordered_test_2",
            "target_schema": {
                "type": "object",
                "properties": {
                    "first_name": {
                        "type": "string",
                        "description": "The first name of the user"
                    },
                    "last_name": {
                        "type": "string",
                        "description": "The last name of the user"
                    }
                },
                "required": [
                    "first_name",
                    "last_name"
                ]
            },
            "source_schema": null,
            "updated_at": null
        }
    ],
    "total": 1,
    "page": 1,
    "size": 50,
    "pages": 1
}

Authorizations

lume-api-key
string
headerrequired

Query Parameters

name
string

The pipeline name to filter by

description
string

The pipeline description to filter by

page
integer
default: 1

Page number

size
integer
default: 50

Page size

Response

200 - application/json
items
object[]
required
total
integer | null
required
page
integer | null
required
size
integer | null
required
pages
integer | null