---
title: "Return Nova account SSO URL"
method: GET
path: "/Nova/ensure_account"
tags: ["Nova"]
---

# Return Nova account SSO URL

`GET /Nova/ensure_account`

## Request

- Base URL: `https://cpanel-server.tld:2083/execute`
- URL: `https://cpanel-server.tld:2083/execute/Nova/ensure_account`
- Auth: HTTP basic

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.

## Query parameters

- `colorScheme` 'light' | 'dark' | 'auto'
- `domain` string
- `promptToken` string
- `return_url` string

## Response `200`

HTTP request succeeded.

- object
  - `apiversion` integer: The version of the API.
  - `func` string: The method name called.
  - `module` string: The name of the module called.
  - `result` object
    - `data` object
      - `created` 1 | 0: Whether the system created a new AI App Builder account.
      - `sso_url` string: The SSO link to the AI App Builder.
    - `errors` string[], nullable: List of errors if the API failed.
    - `messages` string[], nullable: List of messages generated by the API.
    - `metadata` object
      - `transformed` 1: Post-processing may have transformed the data.
    - `status` 1 | 0: - `1` - Success. - `0` - Failed: Check the errors field for more details.
    - `warnings` string[], nullable: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

## Changes

- **2026-09-24** `64a55c1ebd37`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/Nova/ensure_account/get.md)

---

[API](https://skmtc.dev/cpanel/apis/cpanel-uapi.md) - [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/cpanel-uapi/revisions/05239220da37?raw)