BREAGEN Logo
Data Pipeline Management

Pipeline Execution

Execution Operations - Retrieve All Executions GET /executions

Resource URL/api/v1/executions
Response FormatJSON
Requires AuthenticationYes (API Key via X-API-KEY header)
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
includeDataWhether to include execution detailsNoBooleanN/A
statusFilter executions by statusNoStringN/A
workflowIdFilter by workflow IDNoStringN/A
projectIdFilter by project IDNoStringN/A
limitMaximum number of items to returnNoNumber100
cursorPagination cursorNoStringN/A

Valid values for status: "error", "success", "waiting"

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/executions?includeData=true&status=success&limit=50&projectId=VmwOO9HeTEj20kxM' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "data": [
        {
            "id": 1000,
            "data": {},
            "finished": true,
            "mode": "manual",
            "retryOf": null,
            "retrySuccessId": null,
            "startedAt": "2025-04-07T10:00:00.000Z",
            "stoppedAt": "2025-04-07T10:01:00.000Z",
            "workflowId": 1000,
            "waitTill": null,
            "customData": {}
        },
        {
            "id": 1001,
            "data": {},
            "finished": true,
            "mode": "webhook",
            "retryOf": null,
            "retrySuccessId": null,
            "startedAt": "2025-04-07T11:00:00.000Z",
            "stoppedAt": "2025-04-07T11:02:00.000Z",
            "workflowId": 1000,
            "waitTill": null,
            "customData": {}
        }
    ],
    "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

HTTP Responses

HTTP CodeMessage
200Successful Response
401Unauthorized
404Not found

Execution Operations - Retrieve an Execution GET /api/v1/executions/{id}

Resource URL/api/v1/executions/{id}
Response FormatJSON
Requires AuthenticationYes (API Key via X-API-KEY header)
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
idThe ID of the executionYesNumberN/A
includeDataWhether to include execution detailsNoBooleanN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/api/v1/executions/1000?includeData=true' \
-H 'accept: application/json' \
-H 'X-API-KEY: your_api_key_here'

Example Response

{
    "id": 1000,
    "data": {},
    "finished": true,
    "mode": "manual",
    "retryOf": null,
    "retrySuccessId": null,
    "startedAt": "2025-04-07T10:00:00.000Z",
    "stoppedAt": "2025-04-07T10:01:00.000Z",
    "workflowId": 1000,
    "waitTill": null,
    "customData": {}
}

HTTP Responses

HTTP CodeMessage
200Successful Response
401Unauthorized
404Not found

Execution Operations - Delete an Execution DELETE /api/v1/executions/{id}

Resource URL/api/v1/executions/{id}
Response FormatJSON
Requires AuthenticationYes (API Key via X-API-KEY header)
Rate LimitedNot specified
HTTPSAssumed Yes

Parameters

ParameterDescriptionRequiredTypeDefault Value
idThe ID of the execution to deleteYesNumberN/A

Example Request

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

Example Response

{
    "id": 1000,
    "data": {},
    "finished": true,
    "mode": "manual",
    "retryOf": null,
    "retrySuccessId": null,
    "startedAt": "2025-04-07T10:00:00.000Z",
    "stoppedAt": "2025-04-07T10:01:00.000Z",
    "workflowId": 1000,
    "waitTill": null,
    "customData": {}
}

HTTP Responses

HTTP CodeMessage
200Successful Response
401Unauthorized
404Not found

Previous

Wisdom Search

Next

Pipeline Management

On this page