Workflow Execution

POST `/api/v1/workflows/{id}/execute`

Create execute Workflow Async

executeWorkflowAsync starts an async workflow execution Supports both JSON body and multipart form data (for file uploads)

Parameters

Name	In	Type	Required
`id`	path	string	true

Request Body

Type: WorkflowExecutionRequest

Field	Type	Description
`input_mode`	`InputMode`
`single_input`	`string`	(optional)
`batch_config`	`BatchInputConfig`	(optional)

Response

Type: WorkflowExecutionResponse

Field	Type	Description
`id`	`uuid.UUID`
`created_at`	`time.Time`
`updated_at`	`time.Time`
`execution_id`	`string`
`status`	`ExecutionStatus`
`progress`	`ExecutionProgress`	(optional)
`message`	`string`	(optional)

Example

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.seeme.ai/api/v1/workflows/{id}/execute

GET `/api/v1/workflows/{id}/executions`

Get Workflow Executions

getWorkflowExecutions returns all executions for a workflow Project admins and editors (workflows:write) see all executions; project viewers see only their own.

Parameters

Name	In	Type	Required
`id`	path	string	true

Response

Type: []WorkflowExecution

Field	Type	Description
`id`	`string`
`workflow_id`	`string`
`workflow_version_id`	`string`
`user_id`	`string`
`status`	`ExecutionStatus`	Execution status
`progress`	`ExecutionProgress`	(optional)
`started_at`	`time.Time`	(optional)
`completed_at`	`time.Time`	(optional)
`error`	`string`	(optional)
`input_mode`	`InputMode`	Input configuration
`single_input`	`string`	(optional)
`input_file_path`	`string`	Path to uploaded file for async processing (optional)
`input_file_name`	`string`	Original filename (optional)
`batch_config`	`BatchInputConfig`	(optional)
`results`	`json.RawMessage`	Results (stored as JSONB for flexibility) (optional)
`node_executions`	`json.RawMessage`	Node executions (step-by-step data for UI) (optional)
`user`	`User`	Computed/joined fields (optional)
`created_at`	`time.Time`	Metadata
`updated_at`	`time.Time`

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/workflows/{id}/executions

GET `/api/v1/workflows/{id}/executions/{execution_id}`

Get Workflow Execution Handler

getWorkflowExecution returns the status of a workflow execution

Parameters

Name	In	Type	Required
`id`	path	string	true
`execution_id`	path	string	true

Response

Type: WorkflowExecution

Field	Type	Description
`id`	`string`
`workflow_id`	`string`
`workflow_version_id`	`string`
`user_id`	`string`
`status`	`ExecutionStatus`	Execution status
`progress`	`ExecutionProgress`	(optional)
`started_at`	`time.Time`	(optional)
`completed_at`	`time.Time`	(optional)
`error`	`string`	(optional)
`input_mode`	`InputMode`	Input configuration
`single_input`	`string`	(optional)
`input_file_path`	`string`	Path to uploaded file for async processing (optional)
`input_file_name`	`string`	Original filename (optional)
`batch_config`	`BatchInputConfig`	(optional)
`results`	`json.RawMessage`	Results (stored as JSONB for flexibility) (optional)
`node_executions`	`json.RawMessage`	Node executions (step-by-step data for UI) (optional)
`user`	`User`	Computed/joined fields (optional)
`created_at`	`time.Time`	Metadata
`updated_at`	`time.Time`

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/workflows/{id}/executions/{execution_id}

POST `/api/v1/workflows/{id}/executions/{execution_id}/cancel`

Create cancel Workflow Execution

cancelWorkflowExecution cancels a running workflow execution

Parameters

Name	In	Type	Required
`id`	path	string	true
`execution_id`	path	string	true

Response

Type: WorkflowExecution

Field	Type	Description
`id`	`string`
`workflow_id`	`string`
`workflow_version_id`	`string`
`user_id`	`string`
`status`	`ExecutionStatus`	Execution status
`progress`	`ExecutionProgress`	(optional)
`started_at`	`time.Time`	(optional)
`completed_at`	`time.Time`	(optional)
`error`	`string`	(optional)
`input_mode`	`InputMode`	Input configuration
`single_input`	`string`	(optional)
`input_file_path`	`string`	Path to uploaded file for async processing (optional)
`input_file_name`	`string`	Original filename (optional)
`batch_config`	`BatchInputConfig`	(optional)
`results`	`json.RawMessage`	Results (stored as JSONB for flexibility) (optional)
`node_executions`	`json.RawMessage`	Node executions (step-by-step data for UI) (optional)
`user`	`User`	Computed/joined fields (optional)
`created_at`	`time.Time`	Metadata
`updated_at`	`time.Time`

Example

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  https://api.seeme.ai/api/v1/workflows/{id}/executions/{execution_id}/cancel

GET `/api/v1/workflows/{id}/executions/{execution_id}/input-file`

Get Workflow Execution Input File

getWorkflowExecutionInputFile serves the input file for an execution

Parameters

Name	In	Type	Required
`id`	path	string	true
`execution_id`	path	string	true

Example

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/workflows/{id}/executions/{execution_id}/input-file

POST `/api/v1/workflows/{id}/versions/{version_id}/execute`

Create execute Workflow Async

executeWorkflowAsync starts an async workflow execution Supports both JSON body and multipart form data (for file uploads)

Parameters

Name	In	Type	Required
`id`	path	string	true
`version_id`	path	string	true

Request Body

Type: WorkflowExecutionRequest

Field	Type	Description
`input_mode`	`InputMode`
`single_input`	`string`	(optional)
`batch_config`	`BatchInputConfig`	(optional)

Response

Type: WorkflowExecutionResponse

Field	Type	Description
`id`	`uuid.UUID`
`created_at`	`time.Time`
`updated_at`	`time.Time`
`execution_id`	`string`
`status`	`ExecutionStatus`
`progress`	`ExecutionProgress`	(optional)
`message`	`string`	(optional)

Example

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.seeme.ai/api/v1/workflows/{id}/versions/{version_id}/execute

Workflow Execution

POST /api/v1/workflows/{id}/execute

Parameters

Request Body

Response

Example

GET /api/v1/workflows/{id}/executions

Parameters

Response

Example

GET /api/v1/workflows/{id}/executions/{execution_id}

Parameters

Response

Example

POST /api/v1/workflows/{id}/executions/{execution_id}/cancel

Parameters

Response

Example

GET /api/v1/workflows/{id}/executions/{execution_id}/input-file

Parameters

Example

POST /api/v1/workflows/{id}/versions/{version_id}/execute

Parameters

Request Body

Response

Example

POST `/api/v1/workflows/{id}/execute`

GET `/api/v1/workflows/{id}/executions`

GET `/api/v1/workflows/{id}/executions/{execution_id}`

POST `/api/v1/workflows/{id}/executions/{execution_id}/cancel`

GET `/api/v1/workflows/{id}/executions/{execution_id}/input-file`

POST `/api/v1/workflows/{id}/versions/{version_id}/execute`