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

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

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

Generated Version Details

~	value
GENERATOR VERSION	com.valkyrlabs:ValkyrAI API 1.0.1-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	2025-12-03T11:13:18.492704-08:00[America/Los_Angeles]