WorkflowExecutionApi

valkyrai-api

All URIs are relative to http://localhost:8080/v1

Method	HTTP request	Description
cancelWorkflowExecution	POST WorkflowExecutionApi	Cancel a running workflow execution

cancelWorkflowExecution

String

cancelWorkflowExecution(id)

Cancel a running workflow execution

Gracefully cancels a running execution, stopping all pending tasks

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution

try {
    String result = apiInstance.cancelWorkflowExecution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#cancelWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

deleteWorkflowExecution

Void

deleteWorkflowExecution(id)

Delete a WorkflowExecution.

Deletes a specific WorkflowExecution.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution.

try {
    Void result = apiInstance.deleteWorkflowExecution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#deleteWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution.

Return type

Void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getWorkflowExecution

WorkflowExecution

getWorkflowExecution(id)

Retrieve a single WorkflowExecution

Retrieves a single WorkflowExecution for a specific uid.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution.

try {
    WorkflowExecution result = apiInstance.getWorkflowExecution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#getWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution.

Return type

WorkflowExecution

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getWorkflowExecutionList

WorkflowExecution

getWorkflowExecutionList(pagesizesort)

Retrieve a list of WorkflowExecutions

Retrieves a list of WorkflowExecutions.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
Integer page = 0; // Integer | 
Integer size = 20; // Integer | 
List<String> sort = Arrays.asList(); // List<String> | 

try {
    WorkflowExecution result = apiInstance.getWorkflowExecutionList(pagesizesort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#getWorkflowExecutionList");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
page	Integer		[optional] [default to 0]
size	Integer		[optional] [default to 20]
sort	List<String>		[optional]

Return type

WorkflowExecution

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

patchWorkflowExecutionById

WorkflowExecution

patchWorkflowExecutionById(idworkflowExecution)

Partially update an existing WorkflowExecution

Updates an existing WorkflowExecution.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution.
WorkflowExecution workflowExecution = new WorkflowExecution(); // WorkflowExecution | Merge-patch fields for WorkflowExecution.

try {
    WorkflowExecution result = apiInstance.patchWorkflowExecutionById(idworkflowExecution);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#patchWorkflowExecutionById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution.
workflowExecution	WorkflowExecution	Merge-patch fields for WorkflowExecution.

Return type

WorkflowExecution

Authorization

No authorization required

HTTP request headers

• Content-Type: application/merge-patch+jsonapplication/json-patch+jsonapplication/json
• Accept: application/json

pauseWorkflowExecution

Void

pauseWorkflowExecution(id)

Pause a running execution

Pauses execution after current task completes

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution

try {
    Void result = apiInstance.pauseWorkflowExecution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#pauseWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution

Return type

Void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

postWorkflowExecution

WorkflowExecution

postWorkflowExecution(workflowExecution)

Create a new WorkflowExecution

Creates a new WorkflowExecution.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
WorkflowExecution workflowExecution = new WorkflowExecution(); // WorkflowExecution | WorkflowExecution details.

try {
    WorkflowExecution result = apiInstance.postWorkflowExecution(workflowExecution);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#postWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workflowExecution	WorkflowExecution	WorkflowExecution details.

Return type

WorkflowExecution

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

resumeWorkflowExecution

Void

resumeWorkflowExecution(id)

Resume a paused execution

Resumes execution from the paused state

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution

try {
    Void result = apiInstance.resumeWorkflowExecution(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#resumeWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution

Return type

Void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

updateWorkflowExecution

WorkflowExecution

updateWorkflowExecution(idworkflowExecution)

Update an existing WorkflowExecution

Updates an existing WorkflowExecution.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.WorkflowExecutionApi;


WorkflowExecutionApi apiInstance = new WorkflowExecutionApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the WorkflowExecution.
WorkflowExecution workflowExecution = new WorkflowExecution(); // WorkflowExecution | Updated WorkflowExecution details.

try {
    WorkflowExecution result = apiInstance.updateWorkflowExecution(idworkflowExecution);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkflowExecutionApi#updateWorkflowExecution");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the WorkflowExecution.
workflowExecution	WorkflowExecution	Updated WorkflowExecution details.

Return type

WorkflowExecution

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Generated Version Details

~	value
GENERATOR VERSION	com.valkyrlabs:ValkyrAI API 1.0.3-SNAPSHOT
API ARTIFACT	com.valkyrlabs.valkyrai-api.jar
GENERATOR VERSION	org.openapitools.openapi-generator:7.5.0
GENERATOR CLASS	org.openapitools.codegen.languages.SpringCodegen
GENERATED DATE	2026-04-20T19:24:54.195235-07:00[America/Los_Angeles]