Skip to main content

WorkflowApi

valkyrai-api

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

MethodHTTP requestDescription
deleteWorkflowDELETE WorkflowApiDelete a Workflow.

deleteWorkflow

Void
deleteWorkflow(id)

Delete a Workflow.

Deletes a specific Workflow.

Example

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


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

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

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Workflow.

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getWorkflow

Workflow
getWorkflow(id)

Retrieve a single Workflow

Retrieves a single Workflow for a specific uid.

Example

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


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

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

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Workflow.

Return type

Workflow

Authorization

No authorization required

HTTP request headers

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

getWorkflowList

Workflow
getWorkflowList(pagesizesort)

Retrieve a list of Workflows

Retrieves a list of Workflows.

Example

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


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

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

Parameters

NameTypeDescriptionNotes
pageInteger[optional] [default to 0]
sizeInteger[optional] [default to 20]
sortList<String>[optional]

Return type

Workflow

Authorization

No authorization required

HTTP request headers

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

postWorkflow

Workflow
postWorkflow(workflow)

Create a new Workflow

Creates a new Workflow.

Example

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


WorkflowApi apiInstance = new WorkflowApi();
Workflow workflow = new Workflow(); // Workflow | Workflow details.

try {
Workflow result = apiInstance.postWorkflow(workflow);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#postWorkflow");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
workflowWorkflowWorkflow details.

Return type

Workflow

Authorization

No authorization required

HTTP request headers

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

updateWorkflow

Workflow
updateWorkflow(idworkflow)

Update an existing Workflow

Updates an existing Workflow.

Example

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


WorkflowApi apiInstance = new WorkflowApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Workflow.
Workflow workflow = new Workflow(); // Workflow | Updated Workflow details.

try {
Workflow result = apiInstance.updateWorkflow(idworkflow);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowApi#updateWorkflow");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the Workflow.
workflowWorkflowUpdated Workflow details.

Return type

Workflow

Authorization

No authorization required

HTTP request headers

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

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.1-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2025-09-03T16:35:42.569765-07:00[America/Los_Angeles]