Contact CData sales if you are interested in a Connect AI Embed account. Connect AI Embed uses a two-level account structure: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.
- 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.
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
CData sets up a parent account for you and sends you the account information, including the account name and account Id.
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.
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.
Once registered, the administrator of the parent account can sign in to the account. Please accept the terms of service.
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: Set Custom Overrides for Drivers (Optional)
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:Select whether the value should apply to new connections only or to all connections (new and existing).
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 each end user’s connected account (such as Jira or Salesforce), so AI workflows only operate on that user’s own data. A JWT containing aconnection_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.