Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Contact CData sales if you are interested in a Connect AI Embed account. Connect AI Embed uses a two-level account structure:
  • Parent Account—Created by CData for your organization. As the ISV, you use the parent account to manage your entire Connect AI Embed deployment, including creating, viewing, and monitoring sub-accounts through the Connect AI Embed interface or API.
  • Sub-Account—One sub-account is created for each of your customers. Within a sub-account, end users can connect to data sources and query data. The access privileges you grant determine what each end user can create, edit, or delete.
The Connect AI Embed Accounts page contains the sub-account names, external Id, and account Ids for reference.
Click the edit icon to change the account name or external Id. Click the delete icon to delete the sub-account.

​
Connect AI Embed Quickstart

The following is an overview of setting up Connect AI Embed. There are five main steps.

​
Step 1: Create a Parent Account

1
CData sets up a parent account for you and sends you the account information, including the account name and account Id.
2
The administrator of the Connect AI Embed parent account creates a JSON Web Token (JWT), which consists of a private key and a corresponding public key. The private key must be stored according to the security requirements of the product integrated with Connect AI Embed.
3
The administrator provides the public key certificate in Privacy-Enhanced Mail (PEM) format to register the management account. They can register the public key by opening a support ticket with Connect AI.
4
Once registered, the administrator of the parent account can sign in to the account. Please accept the terms of service.
5
The parent account’s administrator creates and manages the sub-accounts.

​
Step 2: Create a Sub-Account

Once you created the parent account, you can create the sub-accounts in one of two ways:
  • In the Accounts page, click +Add account. Enter the Account Name and External ID of the sub-account, and click Confirm.
  • Use Create Account in the Connect AI Embed API to create a sub-account. You must supply the JWT that you created in Create a Parent Account, as well as the External ID of the sub-account.

​
Step 3: Configure Connection Settings (Optional)

Connect AI Embed gives you two ways to configure connection settings centrally across your sub-accounts.
  • Connection Overrides: Configure a connection setting once at the parent account level and push it to all sub-accounts automatically. This eliminates per-tenant maintenance as you scale. See the Sources section in the Settings documentation for configuration steps.
  • Branded OAuth Apps: Register your own OAuth application with data source providers so your customers authenticate under your brand rather than CData’s. When a sub-account user connects Salesforce or another OAuth source, they see your application name—not CData’s. See the Sources section in the Settings documentation for configuration steps.
The existing Custom Overrides feature described below also remains available for other connection property overrides. Custom overrides allows the end users to log in with their own organization’s OAuth credentials, rather than CData credentials. To add connection overrides, follow these steps:
1
In the Sources tab of the Settings page, click +Add Override.
2
Search for the data source to override. Click Next.
3
Select the Setting to override.
4
Enter the Override Value.
5
Select whether the value should apply to new connections only or to all connections (new and existing).
6
Click Confirm.
End users can now use the custom credentials.

​
Step 4: Configure a Connection

An end user of the sub-account clicks Add Connection on your web page. On the backend, your web site calls Create Connection, which generates a redirect URL to the Connect AI Embed web page. The end user can then configure a connection of a certain type, such as a Salesforce connection, and save and test the connection. When the end user is finished, he/she is then redirected back to your web page containing a list of connections. See Connection Flow for more details.

​
Step 5: Query the Data Using AI

Once your data source is connected, your application can use AI to interact with end-user data in natural language. Connect AI Embed’s MCP server bridges your AI agent and your customers’ connected accounts (such as Jira or Salesforce). Each sub-account’s connections are isolated—AI workflows for one sub-account cannot access another’s data. A JWT containing a connection_ids claim, generated by your server, scopes each request to the correct end user. See MCP for more information. You can also use one of the following Connect AI drivers to query the data: In addition, Connect AI Embed provides a full-featured REST API. You can query data directly with any REST-compatible application or integration tool capable of creating HTTP requests.

​
View Logs

Use the Logs page or the Log API to view and download a list of logs for a Connect AI Embed account.