### SSO Setup Guide for CustomGPT.ai Source: https://docs.customgpt.ai/docs/sso-setup A step-by-step guide to configuring Single Sign-On (SSO) for your domain in CustomGPT.ai. This involves accessing profile settings, adding your domain, updating DNS records, and providing SAML details from your identity provider. It also covers customization options for email authentication, user roles, SCIM integration, and email deletion handling. ```text 1. On the bottom-left corner of the screen, click your **profile icon** or **initials** to access profile options. 2. Click **My Profile** from the dropdown menu to open your profile settings. 3. In your profile, click the **Single Sign On (SSO)** tab in the top menu. 4. Under **Add Your Domain** , enter the domain you want to use with SSO. 5. Follow the on-screen instructions to update your DNS records with your DNS provider. 6. The domain status will automatically update to Verified once DNS changes take effect. This typically takes 15–20 minutes, but may take up to 72 hours. > 📘 > ### > Note: > If the domain is not verified after 72 hours, contact our support. 7. Configure your identity provider by following the appropriate guide: * SSO Setup with Google Workspace * SSO Setup with Okta * SSO Setup with PingOne You will need the ACS URL and Entity ID, both provided on the SSO configuration page. 8. Provide your identity provider’s SAML details in one of the following ways: * **Import via URL** * **Import via XML** * **Enter manually** 9. After verifying your domain and completing SAML setup, customize your SSO configuration: * **Email authentication options:** **Allow login only using SSO** or you can **Allow login via SSO and email/password** * **User role configuration:** Assign default roles for new users based on your team’s role settings. * **SCIM integration:** You can **Disabled** – No user sync or **Enabled** – Automatically sync user data (create/update/delete) based on identity provider settings. * **Email deletion handling:** You can **Delete projects with user** or **Transfer projects to your account** (may affect storage credits) ``` -------------------------------- ### SSO Setup Guide for CustomGPT.ai Source: https://docs.customgpt.ai/docs/account-protection A step-by-step guide to configuring Single Sign-On (SSO) for your domain in CustomGPT.ai. This involves accessing profile settings, adding your domain, updating DNS records, and providing SAML details from your identity provider. It also covers customization options for email authentication, user roles, SCIM integration, and email deletion handling. ```text 1. On the bottom-left corner of the screen, click your **profile icon** or **initials** to access profile options. 2. Click **My Profile** from the dropdown menu to open your profile settings. 3. In your profile, click the **Single Sign On (SSO)** tab in the top menu. 4. Under **Add Your Domain** , enter the domain you want to use with SSO. 5. Follow the on-screen instructions to update your DNS records with your DNS provider. 6. The domain status will automatically update to Verified once DNS changes take effect. This typically takes 15–20 minutes, but may take up to 72 hours. > 📘 > ### > Note: > If the domain is not verified after 72 hours, contact our support. 7. Configure your identity provider by following the appropriate guide: * SSO Setup with Google Workspace * SSO Setup with Okta * SSO Setup with PingOne You will need the ACS URL and Entity ID, both provided on the SSO configuration page. 8. Provide your identity provider’s SAML details in one of the following ways: * **Import via URL** * **Import via XML** * **Enter manually** 9. After verifying your domain and completing SAML setup, customize your SSO configuration: * **Email authentication options:** **Allow login only using SSO** or you can **Allow login via SSO and email/password** * **User role configuration:** Assign default roles for new users based on your team’s role settings. * **SCIM integration:** You can **Disabled** – No user sync or **Enabled** – Automatically sync user data (create/update/delete) based on identity provider settings. * **Email deletion handling:** You can **Delete projects with user** or **Transfer projects to your account** (may affect storage credits) ``` -------------------------------- ### Enable and Manage Starter Questions Source: https://docs.customgpt.ai/docs/how-to-create-an-example-question-1 This section outlines the steps to enable and manage starter questions for an AI agent. It involves navigating to the personalization settings, adding questions, and optionally enabling context-rich prompts. ```UI/Configuration 1. On your dashboard, click **Personalize**. 2. Click **Conversation** tab. 3. Click **+** icon in the prompt box and type your question. 4. Click **Add icon** to add your question. 5. You can also toggle on **Context-rich starter questions** to let the agent automatically craft relevant prompts based on the content of the page it’s embedded on. (Available only if Context Awareness is enabled on the agent’s Action page. See the Context-rich starter questions to learn more. 6. Under **Starter Questions header** , enter the text that will appear above all your starter questions (for example, Try asking these questions…). 7. Under **Starter Questions expand** label, enter the text for expanding the list (for example, View more). 8. Under **Starter Questions collapse** label, enter the text for collapsing the list (for example, View less). 9. Click **Save settings** to apply all your updates. ``` -------------------------------- ### Python SDK Installation and Usage Source: https://docs.customgpt.ai/docs/overview This snippet demonstrates how to install the CustomGPT Python SDK using pip and provides a basic example of its usage for interacting with the CustomGPT.ai API. It assumes you have a Bearer token for authentication. ```python pip install customgpt-client from customgpt import CustomGPT # Initialize the client with your API key (Bearer token) # Replace 'YOUR_API_KEY' with your actual token client = CustomGPT(api_key='YOUR_API_KEY') # Example: Get a list of agents (replace with actual API call) # try: # agents = client.agents.list() # print(agents) # except Exception as e: # print(f"An error occurred: {e}") ``` -------------------------------- ### Create a Simple Starter Question Source: https://docs.customgpt.ai/docs/starter-questions This section explains how to create a basic starter question for your AI agent. Starter questions guide users on how to interact with the agent and can be customized to improve user experience. ```Markdown ###### Start typing to search… ## 🏠 Homepage * Welcome to CustomGPT.ai guide! * Overview * API quickstart guide ## 🚀 Getting Started * Create your CustomGPT account * Subscribe to CustomGPT * Email validation policy * Create AI agent from website * Test AI agent * Best practices ## 📋 Account Management * Account management * Your profile * Change your email address * Change password * Forgot password * Delete your account * Analytics, usage and limits * How usage limits work * View limits & usage * Billing * Add a coupon code * Upgrade or change subscription plan * Update billing information * Find your receipt history * Export your invoices * API keys * Generate your API key * Edit your API key * Revoke your API key * How to enable 2FA ## 💬 Agent Management * Managing agents * Access your existing agents * Use the search bar to find agents * Find your agent ID and agent key * Locate event logs * Manage AI agent data * Duplicate an agent * Delete an agent * Managing visibility * Make your agent public * Make your agent private * Agent security * Add re-captcha to your AI agent * Set up domain whitelist for your AI agent * Set your conversation retention period * Access agent settings * Managing conversations * Export agent’s conversation history * Monitor queries & conversations * Delete conversation history * Conversation limits * View my own conversations * Agent uptime ## 🎨 Agent Customization * Agent roles * How to use Agent roles * Customer support * Website copilot * Enterprise search * Revenue agent * Appearance * How it looks * Change agent avatar * Change end-user avatar * Change avatar orientations * Disable In-Chat Agent Avatar * Set user message color * Set the toolbar color * Change the background * Change your AI agent title * Enable Spotlight Avatar * Add terms of service to your AI agent * Persona * Control how your agent acts * Auto-generated personas * Intelligence * Choose the right GPT model for your AI agent * Use fast responses mode for your AI agent * Use highest relevance for your AI agent * Configure and use complex reasoning * Enable agent to use general LLM knowledge * Settings * Starter Questions * Create a simple starter question * Enable context-rich starter questions * How context-rich starter questions work * Conversation * Change your AI agent's language * Add a placeholder prompt * Change loading indicator type * Add a custom message ending to every response * Change the "I don't know the answer" message * Control conversation duration * Disable Markdown in responses * Citations * Activate citations for your AI agent * Change how citations are displayed * Change the citations labels * Disallow using sources in responses * Activate image citations * Control agent’s general knowledge base awareness * Advanced * Manage conversation sharing * Manage conversation exporting * White label your agent * Manage user feedback ``` -------------------------------- ### Specify Crawling Start URL in CustomGPT.ai Source: https://docs.customgpt.ai/docs/what-happens-if-my-website-doesnt-have-a-sitemap This guide explains how to configure CustomGPT.ai to start website crawling from a specific URL instead of the default home page. This is useful for targeting specific sections of a website. ```text 1. Go to the **New Agent** page in your CustomGPT.ai dashboard. 2. Choose **Website** as the data source. 3. Enter the URL you want to start crawling from (e.g., a specific subpage). 4. Click **Not what you expected?** below the URL field. 5. Select the option **Start crawling from the provided URL rather than the home page** and click **Create Agent** to proceed. ``` -------------------------------- ### Create a Simple Starter Question Source: https://docs.customgpt.ai/docs/settings This section explains how to create a basic starter question for your AI agent. Starter questions guide users on how to interact with the agent and can be customized to improve user experience. ```Markdown ###### Start typing to search… ## 🏠 Homepage * Welcome to CustomGPT.ai guide! * Overview * API quickstart guide ## 🚀 Getting Started * Create your CustomGPT account * Subscribe to CustomGPT * Email validation policy * Create AI agent from website * Test AI agent * Best practices ## 📋 Account Management * Account management * Your profile * Change your email address * Change password * Forgot password * Delete your account * Analytics, usage and limits * How usage limits work * View limits & usage * Billing * Add a coupon code * Upgrade or change subscription plan * Update billing information * Find your receipt history * Export your invoices * API keys * Generate your API key * Edit your API key * Revoke your API key * How to enable 2FA ## 💬 Agent Management * Managing agents * Access your existing agents * Use the search bar to find agents * Find your agent ID and agent key * Locate event logs * Manage AI agent data * Duplicate an agent * Delete an agent * Managing visibility * Make your agent public * Make your agent private * Agent security * Add re-captcha to your AI agent * Set up domain whitelist for your AI agent * Set your conversation retention period * Access agent settings * Managing conversations * Export agent’s conversation history * Monitor queries & conversations * Delete conversation history * Conversation limits * View my own conversations * Agent uptime ## 🎨 Agent Customization * Agent roles * How to use Agent roles * Customer support * Website copilot * Enterprise search * Revenue agent * Appearance * How it looks * Change agent avatar * Change end-user avatar * Change avatar orientations * Disable In-Chat Agent Avatar * Set user message color * Set the toolbar color * Change the background * Change your AI agent title * Enable Spotlight Avatar * Add terms of service to your AI agent * Persona * Control how your agent acts * Auto-generated personas * Intelligence * Choose the right GPT model for your AI agent * Use fast responses mode for your AI agent * Use highest relevance for your AI agent * Configure and use complex reasoning * Enable agent to use general LLM knowledge * Settings * Starter Questions * Create a simple starter question * Enable context-rich starter questions * How context-rich starter questions work * Conversation * Change your AI agent's language * Add a placeholder prompt * Change loading indicator type * Add a custom message ending to every response * Change the "I don't know the answer" message * Control conversation duration * Disable Markdown in responses * Citations * Activate citations for your AI agent * Change how citations are displayed * Change the citations labels * Disallow using sources in responses * Activate image citations * Control agent’s general knowledge base awareness * Advanced * Manage conversation sharing * Manage conversation exporting * White label your agent * Manage user feedback ``` -------------------------------- ### Enable Starter Question Feature in CustomGPT.ai Source: https://docs.customgpt.ai/docs/prompt-user-with-a-starter-question This snippet outlines the steps to enable the 'Prompt user with a Starter Question' feature within the CustomGPT.ai dashboard. It involves navigating to the deploy settings and toggling the feature in the Agent behavior section. ```text 1. Navigate to your CustomGPT.ai dashboard, and in the right sidebar click Deploy. 2. Click the Settings icon. 3. Scroll down to the Agent behavior section and toggle on Prompt user with a Starter Question. Make sure you have at least one starter question. See the Starter question guide to learn more. 4. The first starter question will now appear as a clickable visual prompt next to the agent’s avatar on your live chat. ``` -------------------------------- ### Enable User Feedback for AI Agent Source: https://docs.customgpt.ai/docs/manage-user-feedback This guide explains how to enable user feedback collection for your AI agent. After enabling, the agent will start collecting feedback, which can be reviewed and exported. Ensure to save settings to apply the changes. ```text 1. Select the agent, then click **Personalize** in the right-side menu. 1. Go to the **Advanced** tab. 1. Scroll down to the **User Feedback** section and click **Enabled**. Once enabled, your AI agent will begin collecting feedback from users, which can be reviewed and exported later. 1. Click **Save Settings** to apply the changes. ``` -------------------------------- ### Enable 2FA on CustomGPT.ai Source: https://docs.customgpt.ai/docs/how-to-enable-2fa-1 This guide outlines the steps to enable two-factor authentication (2FA) on your CustomGPT.ai account. It involves navigating to profile settings, initiating the 2FA setup, entering your password, scanning a QR code with an authenticator app, entering the generated code, and saving recovery codes. ```text 1. On the bottom-left corner of the screen, click your **profile icon** or **initials** to access profile options. 2. Click **My Profile** from the dropdown menu to open your profile settings. 3. Click the **Security** tab. 4. In the Two-Factor Authentication section, click **Enable**. 5. Enter your password when prompted. 6. Click **Confirm** to proceed. 7. Open an authenticator app (e.g., **Google Authenticator** or **Authy**) on your phone or browser. 8. Choose to **scan the QR code** or **enter the manual key** displayed in your CustomGPT profile and add a nickname to the entry in your app. 9. Enter the 6-digit code from the app into the code field in your CustomGPT profile. 10. Click **Confirm** to complete the setup. 11. Save your recovery codes in a secure location (e.g., a password manager). These can be used to regain access if you lose your authentication device. ``` -------------------------------- ### Configure SSO with PingOne using SAML Source: https://docs.customgpt.ai/docs/sso-setup-with-pingone This guide details the steps to set up Single Sign-On (SSO) and SCIM provisioning between CustomGPT.ai and PingOne using SAML. It covers adding SSO in CustomGPT, configuring SAML applications in PingOne, attribute mapping, and loading SAML configuration. ```SAML Entity ID from CustomGPT SSO settings page ACS URL and EntityID from CustomGPT Set up SSO page IDP Metadata URL ``` -------------------------------- ### Install and Activate CustomGPT.ai WordPress Plugin Source: https://docs.customgpt.ai/docs/how-to-install-the-official-customgptai-wordpress-plugin This snippet outlines the steps to install and activate the CustomGPT.ai plugin from the WordPress plugin directory. It involves searching for the plugin, installing it, and then activating it. ```text 1. Make sure you are logged in to your WordPress site as an administrator. Then, in your WordPress dashboard, go to **Plugins** and click **Add New**. 2. In the search bar, type CustomGPT. 3. When the CustomGPT.ai plugin appears, click **Install Now**. 4. After installation is complete, click **Activate**. ``` -------------------------------- ### Find Website Sitemap Guide Source: https://docs.customgpt.ai/docs/how-to-find-your-sitemap-1 A step-by-step guide to finding a website's sitemap. This process involves entering a website URL, which the tool then uses to generate a sitemap. The generated sitemap can be used for creating new agents or enhancing existing ones. ```text 1. Enter the URL of the website you want to analyze. 2. The tool will automatically generate a sitemap from the provided URL. 3. Your sitemap is ready to use and you can either use it to start a brand new agent or add it to an existing agent. ``` -------------------------------- ### Enable Context-Rich Starter Questions Source: https://docs.customgpt.ai/docs/build-revenue-agent-and-drive-conversions Activates context-rich starter questions in CustomGPT.ai to tailor the conversation to the page. This setting is found in the Personalize section under the Conversation tab. ```CustomGPT.ai 1. Navigate to your CustomGPT dashboard, and in the right sidebar click **Personalize**. 2. Click the **Conversation** tab. 3. Toggle the setting **On** to enable **Context‑rich starter questions**. ``` -------------------------------- ### Test CustomGPT.ai API Endpoints Source: https://docs.customgpt.ai/docs/customgptai-whatsapp-integration This snippet demonstrates how to test CustomGPT.ai API endpoints for WhatsApp integration. It involves retrieving agents using the 'Get Agents List' endpoint to get a projectId, and then using 'Create conversation' or 'Get conversations' to obtain a conversationSessionId. Finally, it shows how to send a message using the 'Send message to conversation' endpoint. ```HTTP GET /agents POST /conversations POST /conversations/{conversationSessionId}/messages ``` -------------------------------- ### CustomGPT.ai Contact and Resources Source: https://docs.customgpt.ai/docs/overview CustomGPT.ai offers a 7-day free trial for all plans. Support is available via chat, email, and phone for enterprise clients. Further information can be found on their website and documentation portal. ```text Contact and Resources: * Website : https://customgpt.ai * Documentation : docs.customgpt.ai * Support : Available via chat, email, and phone (Enterprise) * Free Trial : 7 days for all plans * Demo : Live demo available on website ``` -------------------------------- ### Save Starter Question Settings Source: https://docs.customgpt.ai/docs/starter-questions This snippet outlines the final step in managing starter questions, which is to save all the applied updates to the agent's configuration. ```UI/UX Steps Click **Save settings** to apply all your updates. ``` -------------------------------- ### REST API Authentication Example Source: https://docs.customgpt.ai/docs/overview This example illustrates how to authenticate with the CustomGPT.ai REST API using a Bearer token. It shows the structure of the Authorization header required for API requests. ```http GET /api/v1/agents HTTP/1.1 Host: app.customgpt.ai Authorization: Bearer YOUR_API_KEY Content-Type: application/json ``` -------------------------------- ### Configure SSO with Okta Source: https://docs.customgpt.ai/docs/sso-setup-with-okta This guide provides step-by-step instructions for setting up Single Sign-On (SSO) and SCIM provisioning between CustomGPT.ai and Okta. It involves configuring the Okta application with SAML 2.0 settings, user assignments, and enabling SCIM provisioning with API token authentication. ```text 1. Sign in to your Okta Admin Console. 2. Go to Applications and click Create App Integration. 3. Select SAML 2.0 and click Next. 4. Enter an app name and click Next. 5. Fill in SAML settings: Use ACS and EntityID values from CustomGPT SSO page. For user attributes, select EmailAddress for (3), Email for (4), and use email, Unspecified, user.email for (5). For names, use firstName, Unspecified, user.firstName for (6). 6. Click Next, then Finish. 7. Copy the metadata URL from Okta. 8. Go to Assignments Tab and Assign users from your IdP to your new Application. 9. Go to https://app.customgpt.ai, open My Profile > Single Sign On, and paste the metadata URL in the Load SAML2 Configuration section. 10. Go to General tab in your Okta app, click on Edit and Enable SCIM. 11. Go to Provisioning tab and fill form with these values: - https://app.customgpt.ai/scim/v2 - userName Then paste your CustomGPT API token in Bearer field. Click on Test connection, if everything fine click on Save. 12. Click on Edit and check Create, Update and Deactivate users. Than click on "Save". 13. Go to Assignments Tab and Assign users from your IdP to your new Application. ```