CPcpanel
Nova

Return AI App Builder SSO URL

Changed on

This function returns an AI App Builder website's SSO URL.

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/get_sso_link

Request

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

Query parameters

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

The color scheme Meridian is using, 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

Where Nova's "Back to cPanel" control returns the user. Required for a regular account and rejected for a standalone one. Must be an https URL of at most 2048 characters, on the host the request was made to, with the path "/frontend/meridian/index.html" (optionally prefixed by a cPanel session token) and the in-product route in the fragment.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

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

Changes