SwarmApi

valkyrai-api

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

Method	HTTP request	Description
deleteSwarm	DELETE SwarmApi	Delete a Swarm.

deleteSwarm

Void

deleteSwarm(id)

Delete a Swarm.

Deletes a specific Swarm.

Example

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


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

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

Parameters

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

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getSwarm

Swarm

getSwarm(id)

Retrieve a single Swarm

Retrieves a single Swarm for a specific uid.

Example

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


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

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

Parameters

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

Return type

Swarm

Authorization

No authorization required

HTTP request headers

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

getSwarmList

Swarm

getSwarmList(pagesizesort)

Retrieve a list of Swarms

Retrieves a list of Swarms.

Example

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


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

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

Swarm

Authorization

No authorization required

HTTP request headers

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

postSwarm

Swarm

postSwarm(swarm)

Create a new Swarm

Creates a new Swarm.

Example

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


SwarmApi apiInstance = new SwarmApi();
Swarm swarm = new Swarm(); // Swarm | Swarm details.

try {
    Swarm result = apiInstance.postSwarm(swarm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SwarmApi#postSwarm");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
swarm	Swarm	Swarm details.

Return type

Swarm

Authorization

No authorization required

HTTP request headers

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

updateSwarm

Swarm

updateSwarm(idswarm)

Update an existing Swarm

Updates an existing Swarm.

Example

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


SwarmApi apiInstance = new SwarmApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Swarm.
Swarm swarm = new Swarm(); // Swarm | Updated Swarm details.

try {
    Swarm result = apiInstance.updateSwarm(idswarm);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SwarmApi#updateSwarm");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the Swarm.
swarm	Swarm	Updated Swarm details.

Return type

Swarm

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-12-03T11:13:18.492704-08:00[America/Los_Angeles]