GET
/
pipelines
/
{pipeline_id}
const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const pipeline_id = '<pipeline_id>'; // Replace <pipeline_id> with your actual pipeline ID

fetch(`https://api.lume.ai/pipelines/${pipeline_id}`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.then(data => console.log(data))
.catch(err => console.error(err));
{
    "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
}

Gets an existing pipeline.

See the Pipeline Guide to learn more.

const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const pipeline_id = '<pipeline_id>'; // Replace <pipeline_id> with your actual pipeline ID

fetch(`https://api.lume.ai/pipelines/${pipeline_id}`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.then(data => console.log(data))
.catch(err => console.error(err));
{
    "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
}

Authorizations

lume-api-key
string
headerrequired

Path Parameters

pipeline_id
string
required

Response

200 - application/json
id
string
required

The unique identifier of this object

created_at
string
required

The date and time this object was created

name
string
required

The name of the pipeline. Must be unique within the organization.

description
string | null

The description of the pipeline

target_schema
object
required

The target schema of the pipeline. In json-schema format.

source_schema
object | null

The source schema of the pipeline, infered from the pipeline's jobs. In json-schema format

updated_at
string | null
required

The date and time this object was last updated