Start
Founder login

Create a Product from an HSX program

Check the HSX program, save it as the first Build with its price fixed, and set up the Product. A browser session also gets a start key, shown once. Any other caller makes keys with the CLI: hyperscale key create --product <productId>.

post/v1/products

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/products
  • Auth: HTTP bearer

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

tenantIdstring required

Organization tenant ID

namestring required
partyBindingsobject required
expectedPlanDigeststring

planDigest from the reviewed composer.plan. The transaction recomputes the plan and refuses with plan_stale, returning the new plan, when it differs.

catalogRevisionIdstring

Immutable tenant catalog revision pinned into a Product build

extensionIdsstring[]

Catalog extensions the program resolves from. Provenance only, recorded on the Build.

metadataMetadata (unresolved $ref)
iconProductIcon (unresolved $ref)

Response

Success

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

productBuildIdstring required

Hyperscale product build ID

buildDigeststring required

SHA-256 digest of the resolved product build closure

instrumentIdsstring[] required
capabilityIdsstring[] required
excludedCapabilityIdsstring[] required
kind'app' | 'offering' | 'listing' | 'booking' | 'pool' required
status'pending' | 'active' | 'disabled' | 'closed' required
key_delivery'minted' | 'unavailable' required
startKeyIdstring

Hyperscale API key ID

shown_oncestring

Hyperscale API key secret

shown_once_unavailable_reason'start_key_browser_only'

Only a browser session gets the sandbox start key. Make a key with api_key.sandbox.create (hyperscale key create).

Changes

No recorded changes to this operation across all 1 revision of this API.