Automation — API Reference
Run, pause, or stop automation workflows
10 endpoints across 2 tags.
Workflows
GET /automation-brain/diagrams — Get list of workflows
/api-reference/automation#tag/Workflows/operation/getPaginatedDiagrams
Retrieve a paginated list of workflows.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_LIST_READ
User role permission required: automation_2_journeys: read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | number | optional | The selected page |
limit | query | number | optional | Selected page |
status | query | enum<"All", "Recent", "Draft", "Pending", …> | optional | Filter workflows by status |
sort | query | enum<"Author", "Name", "CreatedTime", "UpdatedTime", …> | optional | Sort workflows by a property value |
sortBy | query | string | optional | Sort workflows clause |
order | query | enum<"Asc", "Desc"> | optional | Sorting order |
search | query | string | optional | A string to search for in workflow names and email addresses of authors. Workflows that don't match the search aren't returned at all. |
directoryId | query | string | optional | UUID of the directory |
Responses
| Status | Description |
|---|---|
200 application/json | A page of workflows |
400 application/json | Bad request: input data missing or malformed |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request GET \
--url 'https://api.synerise.com/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'GET /automation-brain/v2/diagrams — Get list of workflows
/api-reference/automation#tag/Workflows/operation/getPaginatedDiagramsV2
Retrieve a paginated list of workflows.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_LIST_READ
User role permission required: automation_2_journeys: read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | number | optional | The selected page |
limit | query | number | optional | Selected page |
status | query | enum<"All", "Recent", "Draft", "Pending", …> | optional | Filter workflows by status |
sort | query | enum<"Author", "Name", "CreatedTime", "UpdatedTime", …> | optional | Sort workflows by a property value |
sortBy | query | string | optional | Sort workflows clause |
order | query | enum<"Asc", "Desc"> | optional | Sorting order |
search | query | string | optional | A string to search for in workflow names and email addresses of authors. Workflows that don't match the search aren't returned at all. |
directoryId | query | string | optional | UUID of the directory |
tags | query | string | optional |
Responses
| Status | Description |
|---|---|
200 application/json | A page of workflows |
400 application/json | Bad request: input data missing or malformed |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request GET \
--url 'https://api.synerise.com/automation-brain/v2/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&tags=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'POST /automation-brain/diagrams/{diagramId}/run — Run/resume workflow
/api-reference/automation#tag/Workflows/operation/runAutomationDiagram
Run a or resume workflow.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE
User role permission required: automation_2_journeys: execute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
Request body
application/json · automation-brain-DiagramActionRequest
| Field | Type | Required | Description |
|---|---|---|---|
scheduleAction | enum<"On", "Off", "NoAction"> | optional |
Responses
| Status | Description |
|---|---|
200 text/plain | Workflow run/resumed or was already running |
400 application/json | See error message for details |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request POST \
--url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/run \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"scheduleAction":"On"}'POST /automation-brain/diagrams/{diagramId}/pause — Pause workflow
/api-reference/automation#tag/Workflows/operation/pauseAutomationDiagram
Pause a workflow.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE
User role permission required: automation_2_journeys: execute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
Request body
application/json · automation-brain-DiagramActionRequest
| Field | Type | Required | Description |
|---|---|---|---|
scheduleAction | enum<"On", "Off", "NoAction"> | optional |
Responses
| Status | Description |
|---|---|
200 text/plain | Diagram paused or was already paused |
400 application/json | See error message for details |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request POST \
--url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/pause \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"scheduleAction":"On"}'POST /automation-brain/diagrams/{diagramId}/stop — Stop workflow
/api-reference/automation#tag/Workflows/operation/stopAutomationDiagram
Stop a workflow.
WARNING: A stopped workflow can't be restarted.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE
User role permission required: automation_2_journeys: execute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
Responses
| Status | Description |
|---|---|
200 text/plain | Workflow stopped or was already stopped |
400 application/json | See error message for details |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request POST \
--url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/stop \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'POST /automation-brain/diagrams/{diagramId}/schedule-on — Enable schedule for workflow
/api-reference/automation#tag/Workflows/operation/scheduleOnAutomationDiagram
Enable schedule for workflow.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE
User role permission required: automation_2_journeys: execute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
Responses
| Status | Description |
|---|---|
200 text/plain | Workflow scheduled or was already scheduled |
400 application/json | See error message for details |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request POST \
--url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-on \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'POST /automation-brain/diagrams/{diagramId}/schedule-off — Disable schedule for workflow
/api-reference/automation#tag/Workflows/operation/scheduleOffAutomationDiagram
Disable schedule for workflow.
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATON_BRAIN_DIAGRAM_EXECUTE
User role permission required: automation_2_journeys: execute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
Responses
| Status | Description |
|---|---|
200 text/plain | Workflow unscheduled or was already unscheduled |
400 application/json | See error message for details |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | Resource not found |
Example request (cURL)
curl --request POST \
--url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-off \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'GET /automation-brain/diagrams/{diagramId}/statistics — Get workflow statistics with node details
/api-reference/automation#tag/Workflows/operation/getDiagramStatistics
Retrieve workflow execution statistics, including node statistics and metadata (name, type).
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATION_STATS_READ
User role permission required: automation_2_journeys: read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
timePeriod | query | enum<"currentHour", "currentDay", "previousHour", "previousDay"> | optional | Time period for the statistics |
Responses
| Status | Description |
|---|---|
200 application/json | Diagram statistics with node info |
400 application/json | See error message for details |
403 | Insufficient permissions to perform this action |
404 | Diagram not found |
Example request (cURL)
curl --request GET \
--url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/statistics?timePeriod=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'GET /automation-brain/diagrams/{diagramId}/blocks/{blockId}/statistics — Get node statistics
/api-reference/automation#tag/Workflows/operation/getBlockStatistics
Retrieve execution statistics for a single block enriched with block metadata (name, type).
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: AUTOMATION_STATS_READ
User role permission required: automation_2_journeys: read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
diagramId | path | string | required | UUID of the workflow/diagram. |
blockId | path | string | required | UUID of the node |
timePeriod | query | enum<"currentHour", "currentDay", "previousHour", "previousDay"> | optional | Time period for statistics |
Responses
| Status | Description |
|---|---|
200 application/json | Block statistics with block info |
400 application/json | See error message for details |
403 | Insufficient permissions to perform this action |
404 | Diagram or block not found |
Example request (cURL)
curl --request GET \
--url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics?timePeriod=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'Data Processing Job Logs
GET /morph/logs/automation/{automationWorkflowId}/last-run/with-stages — Get last log with stages
/api-reference/automation#tag/Data-Processing-Job-Logs/operation/getExtendedInfoAboutLastRun
Retrieve the status of a workflow's last run and its stages.
The workflow must contain at least one of the following nodes:
- Any Data Transformation node
- Any node that pulls data into a workflow (for example local file, SFTP, Azure Blob Storage)
- Any node that pushes data out of the workflow (for example SFTP, Pub/Sub)
- Any node that imports data into Synerise
API consumers: Synerise User, Workspace (Business Profile)
API key permission required: MORPH_JOBS_READ
User role permission required: automation_2_journeys: read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
automationWorkflowId | path | string | required | diagramId of the workflow to fetch last job from
|
limit | query | number | optional | The maximum number of log lines in each stage |
Responses
| Status | Description |
|---|---|
200 application/json | Information about last data transformation journey status |
401 application/json | Unauthorized: wrong consumer scope; token missing/expired/invalid; invalid API key; etc. |
403 application/json | Forbidden; insufficient permissions |
404 application/json | workflow doesn't exist; no journeys exist for a workflow; workflow doesn't contain any of the required nodes (returns a "no journeys found" error) |
Example request (cURL)
curl --request GET \
--url 'https://api.synerise.com/morph/logs/automation/%7BautomationWorkflowId%7D/last-run/with-stages?limit=SOME_NUMBER_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'