WorkbookApi

valkyrai-api

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

Method	HTTP request	Description
deleteWorkbook	DELETE WorkbookApi	Delete a Workbook.

deleteWorkbook

Void

deleteWorkbook(id)

Delete a Workbook.

Deletes a specific Workbook.

Example

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


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

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

Parameters

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

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getWorkbook

Workbook

getWorkbook(id)

Retrieve a single Workbook

Retrieves a single Workbook for a specific uid.

Example

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


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

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

Parameters

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

Return type

Workbook

Authorization

No authorization required

HTTP request headers

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

getWorkbookList

Workbook

getWorkbookList(pagesizesort)

Retrieve a list of Workbooks

Retrieves a list of Workbooks.

Example

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


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

try {
    Workbook result = apiInstance.getWorkbookList(pagesizesort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkbookApi#getWorkbookList");
    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

Workbook

Authorization

No authorization required

HTTP request headers

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

postWorkbook

Workbook

postWorkbook(workbook)

Create a new Workbook

Creates a new Workbook.

Example

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


WorkbookApi apiInstance = new WorkbookApi();
Workbook workbook = new Workbook(); // Workbook | Workbook details.

try {
    Workbook result = apiInstance.postWorkbook(workbook);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkbookApi#postWorkbook");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
workbook	Workbook	Workbook details.

Return type

Workbook

Authorization

No authorization required

HTTP request headers

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

updateWorkbook

Workbook

updateWorkbook(idworkbook)

Update an existing Workbook

Updates an existing Workbook.

Example

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


WorkbookApi apiInstance = new WorkbookApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Workbook.
Workbook workbook = new Workbook(); // Workbook | Updated Workbook details.

try {
    Workbook result = apiInstance.updateWorkbook(idworkbook);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WorkbookApi#updateWorkbook");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the Workbook.
workbook	Workbook	Updated Workbook details.

Return type

Workbook

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.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-09-03T16:35:42.569765-07:00[America/Los_Angeles]