Workflow Execution

Execute Routes

Resource	Operation	Description
Workflow Execution	POST /ivoryos/executions/optimizer_schema	Get optimizer schema
	POST /ivoryos/executions/campaign	Run Bayesian Optimization campaign
	GET /ivoryos/executions/latest_plot	Get latest optimization plot
Workflow Execution Config	GET /ivoryos/executions/config	Execute/iterate the workflow
	POST /ivoryos/executions/config
Workflow Execution Control	GET /ivoryos/executions/status	Get backend runner status
	POST /ivoryos/executions/abort/next-task	abort all pending tasks starting from the next task
	POST /ivoryos/executions/pause-resume	pause and resume
	POST /ivoryos/executions/retry	retry the failed workflow execution step.
Workflow Execution Files	GET /ivoryos/files/preview/(string:filename)	preview a workflow history file (.CSV)
Workflow Execution Queue	GET /ivoryos/executions/queue	Get queued tasks
	POST /ivoryos/executions/queue/delete	Delete queued task
	POST /ivoryos/executions/queue/reorder	Reorder queued task
	GET /ivoryos/executions/queue/task/(int:task_id)	Get queued task details
	GET /ivoryos/executions/current_task	Get current task details
	POST /ivoryos/executions/queue/task/rename	Rename queued task
Workflow Execution control	POST /ivoryos/executions/abort/next-iteration	abort pending workflow

Execute File Management Routes

Resource	Operation	Description
Workflow Files	GET /ivoryos/files/execution-configs	download an empty workflow config file (.CSV)
	POST /ivoryos/files/batch-configs	upload a workflow config file (.CSV)
	POST /ivoryos/files/execution-data	upload a workflow history file (.CSV)

Execute Docs

GET /ivoryos/executions/config

GET /executions/config

Load the experiment execution interface.

POST /executions/config

Start workflow execution with experiment configuration.

Status Codes:

200 OK – Successfully loaded the config page or started the task.

POST /ivoryos/executions/config

GET /executions/config

Load the experiment execution interface.

POST /executions/config

Start workflow execution with experiment configuration.

Status Codes:

200 OK – Successfully loaded the config page or started the task.

POST /ivoryos/executions/optimizer_schema

Optimizer Schema

POST /executions/optimizer_schema

Retrieve the parameter and configuration schema for a specific optimizer or all available optimizers.

JSON Parameters:

optimizer_type – Optional name of the optimizer to get the schema for.

Status Codes:

200 OK – Returns the requested schema as JSON.

POST /ivoryos/executions/campaign

Run Bayesian Optimization with the given parameters and objectives.

POST /executions/campaign

Start a Bayesian Optimization (BO) campaign using the specified optimizer, parameters, and objectives.

Form Parameters:

repeat – The number of iterations/repeats to run.
optimizer_type – The name of the optimizer to use (e.g., ‘GPyOpt’).
existing_data – Path to an existing CSV file for warm-starting the optimization.
parameters – The search space configuration for parameters.
objectives – The return values to optimize.

Status Codes:

302 Found – Redirects to the execution config page after starting.

GET /ivoryos/executions/latest_plot

Optimizer Plot

GET /executions/latest_plot

Retrieve the most recently generated visualization plot from the active Bayesian Optimization campaign.

Status Codes:

200 OK – Returns the plot image (PNG).
404 Not Found – No plots found.

GET /ivoryos/executions/queue

GET /executions/queue

Retrieve the current execution queue and queue state.

Status Codes:

200 OK – Returns queue status as JSON.

POST /ivoryos/executions/queue/delete

POST /executions/queue/delete

Remove a pending task from the execution queue.

JSON Parameters:

id – Queue task ID to remove.

Status Codes:

200 OK – Task removed.
400 Bad Request – Task could not be removed.

POST /ivoryos/executions/queue/reorder

POST /executions/queue/reorder

Move a pending task up or down in the execution queue.

JSON Parameters:

id – Queue task ID to move.
direction – Direction to move the task.

Status Codes:

200 OK – Task reordered.
400 Bad Request – Task could not be reordered.

GET /ivoryos/executions/queue/task/(int: task_id)

GET /executions/queue/task/<int:task_id>

Retrieve the full payload for a queued task.

Parameters:

task_id – Queue task ID.

Status Codes:

200 OK – Returns task details.
404 Not Found – Task not found.

GET /ivoryos/executions/current_task

GET /executions/current_task

Retrieve details for the currently running task.

Status Codes:

200 OK – Returns current task details.
404 Not Found – No task currently running.

POST /ivoryos/executions/queue/task/rename

POST /executions/queue/task/rename

Update the display name for a queued task.

JSON Parameters:

id – Queue task ID to rename.
new_name – New display name.

Status Codes:

200 OK – Task renamed.
400 Bad Request – Task could not be renamed.

GET /ivoryos/executions/status

Runner Status

GET /executions/status

Check if the system is currently busy and retrieve details about the active task or workflow.

Status Codes:

200 OK – Returns a JSON object containing the ‘busy’ state and current task details.

POST /ivoryos/executions/abort/next-iteration

finish the current iteration and stop pending workflow iterations

POST /executions/abort/next-iteration

POST /ivoryos/executions/abort/next-task

finish the current task and stop all pending tasks or iterations

POST /executions/abort/next-task

POST /ivoryos/executions/pause-resume

pause workflow iterations or resume workflow iterations

POST /executions/pause-resume

POST /ivoryos/executions/retry

retry the failed workflow execution step.

POST /executions/retry

GET /ivoryos/files/preview/(string: filename)

Preview the contents of a workflow history file in CSV format.

GET /files/preview/<str:filename>

Execute File Management Docs

GET /ivoryos/files/execution-configs

GET /files/execution-configs

Form Parameters:

file – workflow design CSV file

Status Codes:

302 Found – load pseudo deck and then redirects to GET /ivoryos/executions/config

POST /ivoryos/files/batch-configs

POST /files/batch-configs

Form Parameters:

file – workflow CSV config file

Status Codes:

302 Found – save csv file and then redirects to GET /ivoryos/executions/config

POST /ivoryos/files/execution-data

POST /files/execution-data

Form Parameters:

file – workflow history CSV file

Status Codes:

302 Found – save csv file and then redirects to GET /ivoryos/executions/config