CData

CData Account API

The Account API from CData — 5 operation(s) for account.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /poweredby/account/list List sub-accounts under the parent account · List Accounts #
Ask an LLM
“How do I see every sub-account under my Connect AI Embed parent account?”
“Which customer sub-accounts have I provisioned so far?”
Tell an agent
List all the sub-accounts under my parent account.
Show me every embedded customer sub-account we have provisioned.
GET /poweredby/account/{accountIdOrExternalId} Look up one sub-account by Id or external Id · Get Sub-Account #
Ask an LLM
“Can I look up a sub-account using my own external Id instead of the Connect AI Id?”
“What details come back for a single embedded sub-account?”
Tell an agent
Get the sub-account {accountIdOrExternalId}.
Look up the sub-account whose external Id is {accountIdOrExternalId}.
POST /poweredby/account/create Create a sub-account for an embedded customer · Create Account #
Ask an LLM
“How do I provision a new sub-account for a customer in Connect AI Embed?”
“Can I create a sub-account with an empty body and fill in the name later?”
Tell an agent
Create a new sub-account named {accountName} with external Id {externalId}.
Provision a blank sub-account for a new customer.
PUT /poweredby/account/update/{subAccountId} Rename or re-key an existing sub-account · Update Sub-Account #
Ask an LLM
“How do I rename a sub-account after it has been created?”
“Can I change the external Id on an existing sub-account?”
Tell an agent
Rename sub-account {subAccountId} to {accountName}.
Change the external Id of sub-account {subAccountId} to {externalId}.
DELETE /poweredby/account/delete/{id} Delete a sub-account · Delete Sub-Account #
Ask an LLM
“How do I remove a customer's sub-account from Connect AI Embed?”
“What happens when I delete an embedded sub-account I no longer need?”
Tell an agent destructive · confirm first
Delete sub-account {id}.
Remove the churned customer's sub-account {id} from the embed product.

Documentation

📖
Documentation
https://cloud.cdata.com/docs/SQL-API.html
📖
Authentication
https://cloud.cdata.com/docs/Authentication.html
📖
APIReference
https://docs.cloud.cdata.com/en/API/REST-API
📖
Documentation
https://cloud.cdata.com/docs/Metadata-API.html
📖
Documentation
https://cloud.cdata.com/docs/Log-API.html
📖
Documentation
https://docs.cloud.cdata.com/en/API/Connection-API
📖
Documentation
https://docs.cloud.cdata.com/en/API/Job-API
📖
Documentation
https://docs.cloud.cdata.com/en/API/Account-API
📖
Documentation
https://cloud.cdata.com/docs/Audit-API.html
📖
Documentation
https://docs.cloud.cdata.com/en/API/Management-API
📖
Documentation
https://docs.cloud.cdata.com/en/API/MCP-Embedded

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/openapi/cdata-account-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-account-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-create-account-result-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-create-account-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-update-account-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/json-schema/cdata-account-list-result-schema.json

Other Resources

🔗
Overview
https://cloud.cdata.com/docs/API.html
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/errors/cdata-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/conventions/cdata-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/data-model/cdata-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/cdata/refs/heads/main/scopes/cdata-scopes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cdata:cdata-account-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cdata-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CData Connect AI REST API Embedded Account API
  version: v1
servers:
- url: https://cloud.cdata.com/api
  description: Production base URL
security:
- BearerAuth: []
tags:
- name: Account
paths:
  /poweredby/account/list:
    get:
      summary: List Accounts
      tags:
      - Account
      operationId: listAccounts
      description: List Accounts lists the sub-accounts within the parent account.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListResult'
              example:
                accounts:
                - id: fee1ce9d-c40c-4ef6-8f8c-77461315713d
                  externalId: ExternalId
                  accountName: Acme Corporation
                  created: '2023-07-13T20:42:56.317Z'
                - id: c6cc4c16-35c8-4657-90c6-f93d401b0ae9
                  externalId: GlobeInc
                  accountName: Globe Inc
                  created: '2024-07-16T18:03:19.622Z'
  /poweredby/account/{accountIdOrExternalId}:
    get:
      summary: Get Sub-Account
      tags:
      - Account
      operationId: getAccount
      description: Get Sub-Account returns a single sub-account within the parent account. You can look up the sub-account by either its internal Connect AI account Id or its external Id.
      parameters:
      - name: accountIdOrExternalId
        in: path
        required: true
        schema:
          type: string
        example: fee1ce9d-c40c-4ef6-8f8c-77461315713d
        description: The internal Connect AI account Id or the external Id of the sub-account.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInfo'
              example:
                id: fee1ce9d-c40c-4ef6-8f8c-77461315713d
                externalId: ExternalId
                accountName: Acme Corporation
                created: '2023-07-13T20:42:56.317Z'
  /poweredby/account/create:
    post:
      summary: Create Account
      tags:
      - Account
      operationId: createAccount
      description: Create Account creates an account in the Connect AI Embed product. All request body fields are optional. If you send an empty body (`{}`), Create Account creates a sub-account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountRequest'
            example:
              externalId: MyExternalId
              accountName: Acme Corporation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountResult'
              example:
                accountId: 8744e71e-ee33-4d4e-916f-0a21eba65902
                externalId: MyExternalId
                createdTime: '2024-07-10T19:10:52.139Z'
  /poweredby/account/update/{subAccountId}:
    put:
      summary: Update Sub-Account
      tags:
      - Account
      operationId: updateAccount
      description: Update Sub-Account updates a sub-account within the parent account. Include only the fields you want to change in the request body.
      parameters:
      - name: subAccountId
        in: path
        required: true
        schema:
          type: string
        example: fee1ce9d-c40c-4ef6-8f8c-77461315713d
        description: The internal Connect AI account Id of the sub-account to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountRequest'
            example:
              externalId: MyExternalId
              accountName: Acme Corporation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInfo'
              example:
                id: fee1ce9d-c40c-4ef6-8f8c-77461315713d
                externalId: MyExternalId
                accountName: Acme Corporation
                created: '2023-07-13T20:42:56.317Z'
  /poweredby/account/delete/{id}:
    delete:
      summary: Delete Sub-Account
      tags:
      - Account
      operationId: deleteAccount
      description: Delete Sub-Account deletes a sub-account from the Connect AI Embed product.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: fee1ce9d-c40c-4ef6-8f8c-77461315713d
        description: The sub-account Id.
      responses:
        '200':
          description: OK
components:
  schemas:
    UpdateAccountRequest:
      type: object
      properties:
        externalId:
          type: string
          description: (Optional) The new external Id for the sub-account.
          nullable: true
        accountName:
          type: string
          description: (Optional) The new display name for the sub-account.
          nullable: true
      additionalProperties: false
    CreateAccountRequest:
      type: object
      properties:
        externalId:
          type: string
          description: (Optional) The external Id of the account to be created.
          nullable: true
        accountName:
          type: string
          description: (Optional) The display name of the account to be created.
          nullable: true
      additionalProperties: false
    AccountListResult:
      type: object
      properties:
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountInfo'
          nullable: true
      additionalProperties: false
    CreateAccountResult:
      type: object
      required:
      - accountId
      - externalId
      - createdTime
      properties:
        accountId:
          type: string
          description: The internal Connect AI account Id.
        externalId:
          type: string
          description: The customer's identifier.
        createdTime:
          type: string
          format: date-time
          description: The time when the account was created.
      additionalProperties: false
    AccountInfo:
      type: object
      required:
      - id
      - externalId
      - created
      properties:
        id:
          type: string
          description: The internal Connect AI account Id.
        externalId:
          type: string
          description: The Connect AI Embed external account identifier.
        accountName:
          type: string
          description: The display name of the account.
          nullable: true
        created:
          type: string
          format: date-time
          description: The time this account was created.
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token authentication. Include the token in the Authorization header as `Bearer {token}`. See [Authentication](/en/API/Authentication-Embedded) for more information on creating a token.