Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.akua.dev/llms.txt

Use this file to discover all available pages before exploring further.

An Offer is a shareable URL (akua.dev/i/<hash>) that sends a customer into the generated install wizard for a Product or Package version. The wizard is rendered from the pinned Package version’s input schema, so customers configure their install without a custom form.

​
The flow

The customer opens the Offer, signs in if required, chooses or creates a workspace, fills the generated form, completes checkout when payment is required, and receives an installation. Each redemption is tracked as an order draft that moves through those states one at a time.

​
What an Offer controls

ControlWhat it does
Target and versionSelects the Product or Package version used by the wizard
Field valuesPre-fills Package inputs and can lock fields the customer should not change
AccessRestricts redemption by email, expiry, maximum uses, or private customer flow
Commercial termsSelects the payment or private-sale path allowed for this customer
Support visibilityLets the seller understand where the customer is in the order flow
Sensitive values are handled as write-only configuration. Saved offers should show that a value exists, not reveal secret material.

​
Generated fields

Each Package input becomes a wizard field. Akua uses:
  • KCL docstrings as help text.
  • @ui(order=...) to sort fields.
  • @ui(group=...) to group related fields.
  • @ui(widget=...) for controls such as sliders, password fields, text areas, and selects.
  • @ui(placeholder=...), @ui(min=...), and @ui(max=...) for form hints and bounds.
See Package format for authoring details.

​
Public catalog vs private offer

PathUse when
Marketplace listingCustomers should discover the Product publicly and start from the catalog.
Reusable OfferYou want a shareable campaign or partner URL with a specific configuration.
Private OfferYou want per-customer terms, email restrictions, expiry, or locked inputs.
All paths create the same kind of order draft and installation. The difference is how much context the seller chooses before the customer starts. To distribute offers through a partner, a private audience, or a beta cohort under reviewed pricing and approval terms, group them behind an Offer channel. Channels are a restricted, request-only entitlement enabled per workspace by Akua.

​
API

Offers API

Create, inspect, archive, unarchive, and resolve offers.

Order Drafts API

Track customer configuration, workspace selection, checkout, and install progress.

Packages API

Fetch Package versions and input schemas used by generated forms.

Authentication

Set up API tokens for seller-side automation.

Marketplace

How products and offers surface to customers.

Products

Sellable wrappers around Package versions.

Packages

Versioned install definitions and input schemas.

Payments

Customer payment flow and Stripe Connect setup.