GoalApi

valkyrai-api

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

Method	HTTP request	Description
deleteGoal	DELETE GoalApi	Delete a Goal.

deleteGoal

Void

deleteGoal(id)

Delete a Goal.

Deletes a specific Goal.

Example

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


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

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

Parameters

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

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getGoal

Goal

getGoal(id)

Retrieve a single Goal

Retrieves a single Goal for a specific uid.

Example

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


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

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

Parameters

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

Return type

Goal

Authorization

No authorization required

HTTP request headers

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

getGoalList

Goal

getGoalList(pagesizesort)

Retrieve a list of Goals

Retrieves a list of Goals.

Example

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


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

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

Goal

Authorization

No authorization required

HTTP request headers

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

postGoal

Goal

postGoal(goal)

Create a new Goal

Creates a new Goal.

Example

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


GoalApi apiInstance = new GoalApi();
Goal goal = new Goal(); // Goal | Goal details.

try {
    Goal result = apiInstance.postGoal(goal);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GoalApi#postGoal");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
goal	Goal	Goal details.

Return type

Goal

Authorization

No authorization required

HTTP request headers

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

updateGoal

Goal

updateGoal(idgoal)

Update an existing Goal

Updates an existing Goal.

Example

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


GoalApi apiInstance = new GoalApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Goal.
Goal goal = new Goal(); // Goal | Updated Goal details.

try {
    Goal result = apiInstance.updateGoal(idgoal);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling GoalApi#updateGoal");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the Goal.
goal	Goal	Updated Goal details.

Return type

Goal

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]