FormatApi

valkyrai-api

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

Method	HTTP request	Description
deleteFormat	DELETE FormatApi	Delete a Format.

deleteFormat

Void

deleteFormat(id)

Delete a Format.

Deletes a specific Format.

Example

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


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

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

Parameters

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

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getFormat

Format

getFormat(id)

Retrieve a single Format

Retrieves a single Format for a specific uid.

Example

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


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

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

Parameters

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

Return type

Format

Authorization

No authorization required

HTTP request headers

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

getFormatList

Format

getFormatList(pagesizesort)

Retrieve a list of Formats

Retrieves a list of Formats.

Example

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


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

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

Format

Authorization

No authorization required

HTTP request headers

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

postFormat

Format

postFormat(format)

Create a new Format

Creates a new Format.

Example

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


FormatApi apiInstance = new FormatApi();
Format format = new Format(); // Format | Format details.

try {
    Format result = apiInstance.postFormat(format);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FormatApi#postFormat");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
format	Format	Format details.

Return type

Format

Authorization

No authorization required

HTTP request headers

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

updateFormat

Format

updateFormat(idformat)

Update an existing Format

Updates an existing Format.

Example

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


FormatApi apiInstance = new FormatApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Format.
Format format = new Format(); // Format | Updated Format details.

try {
    Format result = apiInstance.updateFormat(idformat);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FormatApi#updateFormat");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the Format.
format	Format	Updated Format details.

Return type

Format

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]