CPcpanel
Nova

Return Nova account SSO URL

Changed on

This function ensures an AI App Builder account exists for the caller, then returns an SSO URL. The system reuses existing accounts. For entitled accounts of any tier, the system usually provisions the account eagerly and asynchronously during account creation or package upgrades. This function acts as a fail-safe: it immediately provisions the account for any entitled caller that eager provisioning hasn't already covered.

Note:

This function requires that your package includes the AI App Builder feature.

Important:

When you disable the AI App Builder feature, the system disables this function.

get/Nova/ensure_account

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

colorScheme'light' | 'dark' | 'auto'
Example:light

The color scheme of the Meridian cPanel theme, so Nova can match it.

domainstring
Example:example.com

The domain to use for the AI App Builder website.

promptTokenstring
Example:SSB3YW50IHRvIGNyZWF0ZSBhIHBvcnRmb2xpbyB3ZWJzaXRlIGZvciBteSBwaG90b2dyYXBoeSBidXNpbmVzcw==

A base64-encoded prompt token to pre-populate the user's website generation goals. This allows hosting companies to collect user intent before SSO and pass it through to the Nova interface.

Requirements:

  • Valid base64 encoding — You can use standard or URL-safe variants.
  • Maximum 5000 characters after the system decodes it.
  • Non-empty content — The system ignores empty or whitespace-only prompts.

Example use case:

A hosting company builds a custom landing page that asks, "What kind of website do you want to create?" The user's response is base64-encoded and passed via this parameter, allowing Nova to use it as the initial generation prompt.

return_urlstring
Example:https://cpanel-server.tld:2083/frontend/meridian/index.html#/websites

The URL where Nova's "Back to cPanel" control returns the user. Required for regular accounts, not allowed for standalone accounts. The URL must use HTTPS, use the same host as the request, and have 2048 characters or less. Its path must be /frontend/meridian/index.html (optionally prefixed by a cPanel session token) with the in-product route in the fragment.

Response

HTTP request succeeded.

apiversioninteger

The version of the API.

funcstring

The method name called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "ensure_account",
  "module": "Nova",
  "result": {
    "data": {
      "created": 1,
      "sso_url": "https://my.sitehub.io/website/edit?ssotoken=example"
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes