Skip to main content

SwarmOpsApi

valkyrai-api​

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

MethodHTTP requestDescription
forwardSwarmCommandPOST SwarmOpsApiForward a swarm command

forwardSwarmCommand

SwarmCommandResponse
forwardSwarmCommand(swarmCommandRequest)

Forward a swarm command

Forwards a command message to a specific agent instance or broadcasts to all agents.

Example​

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


SwarmOpsApi apiInstance = new SwarmOpsApi();
SwarmCommandRequest swarmCommandRequest = new SwarmCommandRequest(); // SwarmCommandRequest |

try {
SwarmCommandResponse result = apiInstance.forwardSwarmCommand(swarmCommandRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SwarmOpsApi#forwardSwarmCommand");
e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
swarmCommandRequestSwarmCommandRequest

Return type​

SwarmCommandResponse

Authorization​

No authorization required

HTTP request headers​

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

getSwarmGraphSnapshot

SwarmGraphSnapshot
getSwarmGraphSnapshot()

Fetch swarm topology snapshot

Returns the current swarm graph nodes and edges for live coordination telemetry.

Example​

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


SwarmOpsApi apiInstance = new SwarmOpsApi();

try {
SwarmGraphSnapshot result = apiInstance.getSwarmGraphSnapshot();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SwarmOpsApi#getSwarmGraphSnapshot");
e.printStackTrace();
}

Parameters​

This endpoint does not need any parameter.

Return type​

SwarmGraphSnapshot

Authorization​

No authorization required

HTTP request headers​

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

registerSwarmAgent

SwarmRegisterResponse
registerSwarmAgent(swarmRegisterRequest)

Register or refresh a swarm agent

Registers an agent instance with the swarm registry and updates its metadata. Subject to ACL and billing constraints.

Example​

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


SwarmOpsApi apiInstance = new SwarmOpsApi();
SwarmRegisterRequest swarmRegisterRequest = new SwarmRegisterRequest(); // SwarmRegisterRequest |

try {
SwarmRegisterResponse result = apiInstance.registerSwarmAgent(swarmRegisterRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SwarmOpsApi#registerSwarmAgent");
e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
swarmRegisterRequestSwarmRegisterRequest

Return type​

SwarmRegisterResponse

Authorization​

No authorization required

HTTP request headers​

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

sendAgentChatMessage

AgentChatMessageResponse
sendAgentChatMessage(agentIdagentChatMessageRequest)

Send chat message to agent

Sends a chat message to a specific agent instance. Messages are persisted and encrypted.

Example​

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


SwarmOpsApi apiInstance = new SwarmOpsApi();
UUID agentId = UUID.randomUUID(); // UUID |
AgentChatMessageRequest agentChatMessageRequest = new AgentChatMessageRequest(); // AgentChatMessageRequest |

try {
AgentChatMessageResponse result = apiInstance.sendAgentChatMessage(agentIdagentChatMessageRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SwarmOpsApi#sendAgentChatMessage");
e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
agentIdUUID
agentChatMessageRequestAgentChatMessageRequest

Return type​

AgentChatMessageResponse

Authorization​

No authorization required

HTTP request headers​

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

unregisterSwarmAgent

SwarmUnregisterResponse
unregisterSwarmAgent(swarmUnregisterRequest)

Unregister a swarm agent

Removes an agent instance from the swarm registry.

Example​

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


SwarmOpsApi apiInstance = new SwarmOpsApi();
SwarmUnregisterRequest swarmUnregisterRequest = new SwarmUnregisterRequest(); // SwarmUnregisterRequest |

try {
SwarmUnregisterResponse result = apiInstance.unregisterSwarmAgent(swarmUnregisterRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SwarmOpsApi#unregisterSwarmAgent");
e.printStackTrace();
}

Parameters​

NameTypeDescriptionNotes
swarmUnregisterRequestSwarmUnregisterRequest

Return type​

SwarmUnregisterResponse

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.3-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2026-05-16T11:45:23.900207-07:00[America/Los_Angeles]