Pipeline Management

Pipeline Operations - Create a Pipeline `POST` /pipelines

Resource URL	/api/v1/pipelines
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
(Request Body)	Pipeline object to be created	Yes	Object	N/A

Request Body

The request body is an object with the following required properties:

Property	Description	Required	Type	Example Value
name	Name of the Pipeline	Yes	String	"My Pipeline"
nodes	Array of nodes in the Pipeline	Yes	Array	See example below
connections	Connections between nodes	Yes	Object	See example below
settings	Pipeline settings	Yes	Object	See example below

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/pipelines' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
    "name": "My Pipeline",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        },
        {
            "id": "51eb5852-ce0b-4806-b4ff-e41322a4041a",
            "name": "Send Email",
            "type": "nodes-base.emailSend",
            "typeVersion": 1,
            "position": [300, 200],
            "parameters": {
                "to": "[email protected]",
                "subject": "Test Email",
                "text": "This is a test email."
            }
        }
    ],
    "connections": {
        "Start": {
            "main": [
                {
                    "node": "Send Email",
                    "type": "main",
                    "index": 0
                }
            ]
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "timezone": "America/New_York"
    }
}'

Example Response

{
    "id": "2tUt1wbLX592XDdX",
    "name": "My Pipeline",
    "active": false,
    "createdAt": "2025-04-08T10:00:00.000Z",
    "updatedAt": "2025-04-08T10:00:00.000Z",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        },
        {
            "id": "51eb5852-ce0b-4806-b4ff-e41322a4041a",
            "name": "Send Email",
            "type": "nodes-base.emailSend",
            "typeVersion": 1,
            "position": [300, 200],
            "parameters": {
                "to": "[email protected]",
                "subject": "Test Email",
                "text": "This is a test email."
            }
        }
    ],
    "connections": {
        "Start": {
            "main": [
                {
                    "node": "Send Email",
                    "type": "main",
                    "index": 0
                }
            ]
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "timezone": "America/New_York"
    },
    "tags": []
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
401	Unauthorized

Pipeline Operations - Retrieve All pipelines `GET` /pipelines

Resource URL	/api/v1/pipelines
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
active	Filter by active status	No	Boolean	N/A
tags	Filter by comma-separated tag names	No	String	N/A
name	Filter by Pipeline name	No	String	N/A
projectId	Filter by project ID	No	String	N/A
excludePinnedData	Exclude pinned data from response	No	Boolean	N/A
limit	Maximum number of items to return	No	Number	100
cursor	Pagination cursor	No	String	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/pipelines?active=true&tags=test,production&limit=50&projectId=VmwOO9HeTEj20kxM' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "data": [
        {
            "id": "2tUt1wbLX592XDdX",
            "name": "My Pipeline",
            "active": true,
            "createdAt": "2025-04-08T10:00:00.000Z",
            "updatedAt": "2025-04-08T10:00:00.000Z",
            "nodes": [
                {
                    "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
                    "name": "Start",
                    "type": "nodes-base.start",
                    "typeVersion": 1,
                    "position": [100, 200]
                }
            ],
            "connections": {
                "Start": {
                    "main": []
                }
            },
            "settings": {
                "saveExecutionProgress": true,
                "saveManualExecutions": true,
                "saveDataErrorExecution": "all",
                "saveDataSuccessExecution": "all",
                "executionTimeout": 3600,
                "timezone": "America/New_York"
            },
            "tags": [
                {
                    "id": "tag1",
                    "name": "test"
                },
                {
                    "id": "tag2",
                    "name": "production"
                }
            ]
        }
    ],
    "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

HTTP Responses

HTTP Code	Message
200	Successful Response
401	Unauthorized

Pipeline Operations - Retrieve a Pipeline `GET` /pipelines/{id}

Resource URL	/api/v1/pipelines/{id}
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline	Yes	String	N/A
excludePinnedData	Exclude pinned data from response	No	Boolean	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX?excludePinnedData=true' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "id": "2tUt1wbLX592XDdX",
    "name": "My Pipeline",
    "active": true,
    "createdAt": "2025-04-08T10:00:00.000Z",
    "updatedAt": "2025-04-08T10:00:00.000Z",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        },
        {
            "id": "51eb5852-ce0b-4806-b4ff-e41322a4041a",
            "name": "Send Email",
            "type": "nodes-base.emailSend",
            "typeVersion": 1,
            "position": [300, 200],
            "parameters": {
                "to": "[email protected]",
                "subject": "Test Email",
                "text": "This is a test email."
            }
        }
    ],
    "connections": {
        "Start": {
            "main": [
                {
                    "node": "Send Email",
                    "type": "main",
                    "index": 0
                }
            ]
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "timezone": "America/New_York"
    },
    "tags": [
        {
            "id": "tag1",
            "name": "test"
        }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
401	Unauthorized
404	Not Found

Pipeline Operations - Delete a Pipeline `DELETE` /api/v1/pipelines/{id}

Resource URL	/api/v1/pipelines/{id}
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline to delete	Yes	String	N/A

Example Request

curl -X 'DELETE' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "id": "2tUt1wbLX592XDdX",
    "name": "My Pipeline",
    "active": true,
    "createdAt": "2025-04-08T10:00:00.000Z",
    "updatedAt": "2025-04-08T10:00:00.000Z",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        }
    ],
    "connections": {
        "Start": {
            "main": []
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "timezone": "America/New_York"
    },
    "tags": [
        {
            "id": "tag1",
            "name": "test"
        }
    ]
}

HTTP Responses

HTTP Code	Message
200	Successful Response
401	Unauthorized
404	Not Found

Pipeline Operations - Update a Pipeline `PUT` /api/v1/pipelines/{id}

Resource URL	/api/v1/pipelines/{id}
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline to update	Yes	String	N/A
(Request Body)	Updated Pipeline object	Yes	Object	N/A

Request Body

The request body is an object with the following required properties:

Property	Description	Required	Type	Example Value
name	Name of the Pipeline	Yes	String	"Updated Pipeline"
nodes	Array of nodes in the Pipeline	Yes	Array	See example below
connections	Connections between nodes	Yes	Object	See example below
settings	Pipeline settings	Yes	Object	See example below

Example Request

curl -X 'PUT' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Updated Pipeline",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        },
        {
            "id": "51eb5852-ce0b-4806-b4ff-e41322a4041a",
            "name": "Send Updated Email",
            "type": "nodes-base.emailSend",
            "typeVersion": 1,
            "position": [300, 200],
            "parameters": {
                "to": "[email protected]",
                "subject": "Updated Test Email",
                "text": "This is an updated test email."
            }
        }
    ],
    "connections": {
        "Start": {
            "main": [
                {
                    "node": "Send Updated Email",
                    "type": "main",
                    "index": 0
                }
            ]
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 7200,
        "timezone": "America/New_York"
    }
}'

Example Response

{
    "id": "2tUt1wbLX592XDdX",
    "name": "Updated Pipeline",
    "active": false,
    "createdAt": "2025-04-08T10:00:00.000Z",
    "updatedAt": "2025-04-08T12:00:00.000Z",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        },
        {
            "id": "51eb5852-ce0b-4806-b4ff-e41322a4041a",
            "name": "Send Updated Email",
            "type": "nodes-base.emailSend",
            "typeVersion": 1,
            "position": [300, 200],
            "parameters": {
                "to": "[email protected]",
                "subject": "Updated Test Email",
                "text": "This is an updated test email."
            }
        }
    ],
    "connections": {
        "Start": {
            "main": [
                {
                    "node": "Send Updated Email",
                    "type": "main",
                    "index": 0
                }
            ]
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 7200,
        "timezone": "America/New_York"
    },
    "tags": []
}

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
401	Unauthorized
404	Not found

Pipeline Operations - Activate a Pipeline `POST` /api/v1/pipelines/{id}/activate

Resource URL	/api/v1/pipelines/{id}/activate
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline to activate	Yes	String	N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX/activate' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "id": "2tUt1wbLX592XDdX",
    "name": "My Pipeline",
    "active": true,
    "createdAt": "2025-04-08T10:00:00.000Z",
    "updatedAt": "2025-04-08T12:00:00.000Z",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        }
    ],
    "connections": {
        "Start": {
            "main": []
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "timezone": "America/New_York"
    },
    "tags": []
}

HTTP Responses

HTTP Code	Message
200	Successful Response
401	Unauthorized
404	Not Found

Pipeline Operations - Deactivate a Pipeline `POST` /api/v1/pipelines/{id}/deactivate

Resource URL	/api/v1/pipelines/{id}/deactivate
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline to deactivate	Yes	String	N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX/deactivate' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "id": "2tUt1wbLX592XDdX",
    "name": "My Pipeline",
    "active": false,
    "createdAt": "2025-04-08T10:00:00.000Z",
    "updatedAt": "2025-04-08T12:00:00.000Z",
    "nodes": [
        {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Start",
            "type": "nodes-base.start",
            "typeVersion": 1,
            "position": [100, 200]
        }
    ],
    "connections": {
        "Start": {
            "main": []
        }
    },
    "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "timezone": "America/New_York"
    },
    "tags": []
}

HTTP Responses

HTTP Code	Message
200	Successful Response
401	Unauthorized
404	Not Found

Pipeline Operations - Transfer a Pipeline to Another Project `PUT` /api/v1/pipelines/{id}/transfer

Resource URL	/api/v1/pipelines/{id}/transfer
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline to transfer	Yes	String	N/A
(Request Body)	Destination project information	Yes	Object	N/A

Request Body

The request body is an object with the following required property:

Property	Description	Required	Type	Example Value
destinationProjectId	The ID of the project to transfer the Pipeline to	Yes	String	"VmwOO9HeTEj20kxM"

Example Request

curl -X 'PUT' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX/transfer' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
    "destinationProjectId": "VmwOO9HeTEj20kxM"
}'

Example Response

This endpoint returns no content on success (HTTP 200):

<No content>

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
401	Unauthorized
404	Not Found

Pipeline Operations - Transfer a Credential to Another Project `PUT` /api/v1/credentials/{id}/transfer

Resource URL	/api/v1/credentials/{id}/transfer
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the credential to transfer	Yes	String	N/A
(Request Body)	Destination project information	Yes	Object	N/A

Request Body

The request body is an object with the following required property:

Property	Description	Required	Type	Example Value
destinationProjectId	The ID of the project to transfer the credential to	Yes	String	"VmwOO9HeTEj20kxM"

Example Request

curl -X 'PUT' \
'https://braegen.ai/api/v1/credentials/R2DjclaysHbqn778/transfer' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
    "destinationProjectId": "VmwOO9HeTEj20kxM"
}'

Example Response

This endpoint returns no content on success (HTTP 200):

<No content>

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
401	Unauthorized
404	Not Found

Pipeline Operations - Get Pipeline Tags `GET` /api/v1/pipelines/{id}/tags

Resource URL	/api/v1/pipelines/{id}/tags
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline	Yes	String	N/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX/tags' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

[
    {
        "id": "tag1",
        "name": "test",
        "createdAt": "2025-04-08T09:00:00.000Z",
        "updatedAt": "2025-04-08T09:00:00.000Z"
    },
    {
        "id": "tag2",
        "name": "production",
        "createdAt": "2025-04-08T09:05:00.000Z",
        "updatedAt": "2025-04-08T09:05:00.000Z"
    }
]

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
401	Unauthorized
404	Not Found

Pipeline Operations - Update Tags of a Pipeline `PUT` /api/v1/pipelines/{id}/tags

Resource URL	/api/v1/pipelines/{id}/tags
Response Format	JSON
Requires Authentication	Yes (API Key via `X-API-KEY` header)
Rate Limited	Not specified
HTTPS	Assumed Yes

Parameters

Parameter	Description	Required	Type	Default Value
id	The ID of the Pipeline	Yes	String	N/A
(Request Body)	List of tag IDs to assign	Yes	Array	N/A

Request Body

The request body is an array of objects, each with the following required property:

Property	Description	Required	Type	Example Value
id	The ID of a tag to assign to the Pipeline	Yes	String	"tag1"

Example Request

curl -X 'PUT' \
'https://braegen.ai/api/v1/pipelines/2tUt1wbLX592XDdX/tags' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here' \
-H 'Content-Type: application/json' \
-d '[
    {"id": "tag1"},
    {"id": "tag2"}
]'

Example Request

[
    {
        "id": "tag1",
        "name": "test",
        "createdAt": "2025-04-08T09:00:00.000Z",
        "updatedAt": "2025-04-08T09:00:00.000Z"
    },
    {
        "id": "tag2",
        "name": "production",
        "createdAt": "2025-04-08T09:05:00.000Z",
        "updatedAt": "2025-04-08T09:05:00.000Z"
    }
]

HTTP Responses

HTTP Code	Message
200	Successful Response
400	Bad Request
401	Unauthorized
404	Not Found

Pipeline Management

Pipeline Operations - Create a Pipeline POST /pipelines

HTTP Responses

Pipeline Operations - Retrieve All pipelines GET /pipelines

HTTP Responses

Pipeline Operations - Retrieve a Pipeline GET /pipelines/{id}

HTTP Responses

Pipeline Operations - Delete a Pipeline DELETE /api/v1/pipelines/{id}

HTTP Responses

Pipeline Operations - Update a Pipeline PUT /api/v1/pipelines/{id}

HTTP Responses

Pipeline Operations - Activate a Pipeline POST /api/v1/pipelines/{id}/activate

HTTP Responses

Pipeline Operations - Deactivate a Pipeline POST /api/v1/pipelines/{id}/deactivate

HTTP Responses

Pipeline Operations - Transfer a Pipeline to Another Project PUT /api/v1/pipelines/{id}/transfer

HTTP Responses

Pipeline Operations - Transfer a Credential to Another Project PUT /api/v1/credentials/{id}/transfer

HTTP Responses

Pipeline Operations - Get Pipeline Tags GET /api/v1/pipelines/{id}/tags

HTTP Responses

Pipeline Operations - Update Tags of a Pipeline PUT /api/v1/pipelines/{id}/tags

HTTP Responses

On this page

Pipeline Operations - Create a Pipeline `POST` /pipelines

Pipeline Operations - Retrieve All pipelines `GET` /pipelines

Pipeline Operations - Retrieve a Pipeline `GET` /pipelines/{id}

Pipeline Operations - Delete a Pipeline `DELETE` /api/v1/pipelines/{id}

Pipeline Operations - Update a Pipeline `PUT` /api/v1/pipelines/{id}

Pipeline Operations - Activate a Pipeline `POST` /api/v1/pipelines/{id}/activate

Pipeline Operations - Deactivate a Pipeline `POST` /api/v1/pipelines/{id}/deactivate

Pipeline Operations - Transfer a Pipeline to Another Project `PUT` /api/v1/pipelines/{id}/transfer

Pipeline Operations - Transfer a Credential to Another Project `PUT` /api/v1/credentials/{id}/transfer

Pipeline Operations - Get Pipeline Tags `GET` /api/v1/pipelines/{id}/tags

Pipeline Operations - Update Tags of a Pipeline `PUT` /api/v1/pipelines/{id}/tags