ProductFunnelWizardApi

valkyrai-api

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

Method	HTTP request	Description
getWizardStatus	GET ProductFunnelWizardApi	Get wizard status and progress

getWizardStatus

WizardStatusResponse

getWizardStatus(wizardId)

Get wizard status and progress

Returns the current status, progress, and generated asset references.

Example

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


ProductFunnelWizardApi apiInstance = new ProductFunnelWizardApi();
UUID wizardId = UUID.randomUUID(); // UUID | 

try {
    WizardStatusResponse result = apiInstance.getWizardStatus(wizardId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProductFunnelWizardApi#getWizardStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
wizardId	UUID

Return type

WizardStatusResponse

Authorization

No authorization required

HTTP request headers

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

previewFunnel

String

previewFunnel(wizardId)

Preview generated landing page HTML

Returns an HTML preview of the generated landing page for review.

Example

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


ProductFunnelWizardApi apiInstance = new ProductFunnelWizardApi();
UUID wizardId = UUID.randomUUID(); // UUID | 

try {
    String result = apiInstance.previewFunnel(wizardId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProductFunnelWizardApi#previewFunnel");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
wizardId	UUID

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/html

publishFunnel

PublishFunnel200Response

publishFunnel(wizardId)

Publish generated funnel

Marks the generated landing page as published and returns the public URL.

Example

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


ProductFunnelWizardApi apiInstance = new ProductFunnelWizardApi();
UUID wizardId = UUID.randomUUID(); // UUID | 

try {
    PublishFunnel200Response result = apiInstance.publishFunnel(wizardId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProductFunnelWizardApi#publishFunnel");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
wizardId	UUID

Return type

PublishFunnel200Response

Authorization

No authorization required

HTTP request headers

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

startFunnelWizard

WizardStartResponse

startFunnelWizard(productFunnelWizard)

Start funnel generation wizard for a product

Begins asynchronous funnel generation using the FunnelGenerator workflow.

Example

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


ProductFunnelWizardApi apiInstance = new ProductFunnelWizardApi();
ProductFunnelWizard productFunnelWizard = new ProductFunnelWizard(); // ProductFunnelWizard | 

try {
    WizardStartResponse result = apiInstance.startFunnelWizard(productFunnelWizard);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProductFunnelWizardApi#startFunnelWizard");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
productFunnelWizard	ProductFunnelWizard

Return type

WizardStartResponse

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]