CampaignApi

valkyrai-api

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

Method	HTTP request	Description
deleteCampaign	DELETE CampaignApi	Delete a Campaign.

deleteCampaign

Void

deleteCampaign(id)

Delete a Campaign.

Deletes a specific Campaign.

Example

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


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

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

Parameters

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

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getCampaign

Campaign

getCampaign(id)

Retrieve a single Campaign

Retrieves a single Campaign for a specific uid.

Example

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


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

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

Parameters

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

Return type

Campaign

Authorization

No authorization required

HTTP request headers

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

getCampaignList

Campaign

getCampaignList()

Retrieve a list of Campaigns

Retrieves a list of Campaigns.

Example

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


CampaignApi apiInstance = new CampaignApi();

try {
    Campaign result = apiInstance.getCampaignList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignApi#getCampaignList");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Campaign

Authorization

No authorization required

HTTP request headers

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

postCampaign

Campaign

postCampaign(campaign)

Create a new Campaign

Creates a new Campaign.

Example

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


CampaignApi apiInstance = new CampaignApi();
Campaign campaign = new Campaign(); // Campaign | Campaign details.

try {
    Campaign result = apiInstance.postCampaign(campaign);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignApi#postCampaign");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
campaign	Campaign	Campaign details.

Return type

Campaign

Authorization

No authorization required

HTTP request headers

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

updateCampaign

Campaign

updateCampaign(idcampaign)

Update an existing Campaign

Updates an existing Campaign.

Example

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


CampaignApi apiInstance = new CampaignApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Campaign.
Campaign campaign = new Campaign(); // Campaign | Updated Campaign details.

try {
    Campaign result = apiInstance.updateCampaign(idcampaign);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CampaignApi#updateCampaign");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	UUID	Unique identifier for the Campaign.
campaign	Campaign	Updated Campaign details.

Return type

Campaign

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-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-04-09T20:27:13.881184-07:00[America/Los_Angeles]