---
title: "Return AI App Builder SSO URL"
method: GET
path: "/Nova/get_sso_link"
tags: ["Nova"]
---

# Return AI App Builder SSO URL

`GET /Nova/get_sso_link`

## Request

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

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.

## Query parameters

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

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer: The version of the API.
  - `func` string: The name of the method called.
  - `module` string: The name of the module called.
  - `result` object
    - `data` 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/get_sso_link/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)