Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
    AI Lake - Databases
      (BETA) List AI Lake Database instancesget(BETA) Create a new AILake Database instancepost(BETA) Get the specified AILake Database instanceget(BETA) Delete an existing AILake Database instancedelete(BETA) Update the data source of an AILake Database instancepatch(BETA) List data sources of an AILake Database instanceget(BETA) Add a data source to an AILake Database instancepost(BETA) Remove a data source from an AILake Database instancedelete(BETA) List registered AI Lake ObjectStoragesget
    AI Lake - Pipe Tables
    AI Lake - Services & Operations
AI Assistant
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

AI Lake - Databases

Endpoint:/

(BETA) List AI Lake Database instances

GET
/api/v1/ailake/database/instances

(BETA) Lists database instances in the organization's AI Lake.

(BETA) List AI Lake Database instances › query Parameters

  • pagestring · min: 0

    Zero-based page number.

    Zero-based page number.

    Default: 0
  • sizestring · min: 1 · max: 500

    Number of items per page.

    Number of items per page.

    Default: 50
  • metaIncludestring[] · unique

(BETA) List AI Lake Database instances › Responses

AI Lake database instances successfully retrieved

  • dataobject[] · required

    Array of resource items

  • linksobject · required

    Links object for a list response

  • metaobject

    Metadata for a paginated list response

GET /api/v1/ailake/database/instances

(BETA) Create a new AILake Database instance

POST
/api/v1/ailake/database/instances

(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.

(BETA) Create a new AILake Database instance › Headers

  • operation-idstring

(BETA) Create a new AILake Database instance › Request Body

  • namestring · required

    Name of the database instance

  • storageIdsstring[] · unique · required

    Set of ids of the storage instances this database instance should access.

  • dataSourceIdstring

    Identifier for the data source created in metadata-api. Defaults to the database name.

  • dataSourceNamestring

    Display name for the data source created in metadata-api. Defaults to the database name.

(BETA) Create a new AILake Database instance › Responses

Accepted

POST /api/v1/ailake/database/instances

(BETA) Get the specified AILake Database instance

GET
/api/v1/ailake/database/instances/{instanceId}

(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.

(BETA) Get the specified AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Get the specified AILake Database instance › Responses

AI Lake database instance successfully retrieved

  • dataobject · required

    A single JSON:API resource item

  • linksobject · required

    Links object for a list response

GET /api/v1/ailake/database/instances/{instanceId}

(BETA) Delete an existing AILake Database instance

DELETE
/api/v1/ailake/database/instances/{instanceId}

(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.

(BETA) Delete an existing AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Delete an existing AILake Database instance › Headers

  • operation-idstring

(BETA) Delete an existing AILake Database instance › Responses

Accepted

DELETE /api/v1/ailake/database/instances/{instanceId}

(BETA) Update the data source of an AILake Database instance

PATCH
/api/v1/ailake/database/instances/{instanceId}/dataSource

(BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.

(BETA) Update the data source of an AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Update the data source of an AILake Database instance › Request Body

  • dataSourceIdstring · required

    New identifier for the data source in metadata-api. Must be unique within the organization.

  • oldDataSourceIdstring · required

    Identifier of the existing data source to replace.

  • dataSourceNamestring

    New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.

(BETA) Update the data source of an AILake Database instance › Responses

Data source successfully updated

  • dataSourceIdstring · required

    New identifier of the data source in metadata-api.

  • dataSourceNamestring · required

    New display name of the data source in metadata-api.

PATCH /api/v1/ailake/database/instances/{instanceId}/dataSource

(BETA) List data sources of an AILake Database instance

GET
/api/v1/ailake/database/instances/{instanceId}/dataSources

(BETA) Returns data source associations for the specified AI Lake database instance.

(BETA) List data sources of an AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) List data sources of an AILake Database instance › query Parameters

  • pagestring · min: 0

    Zero-based page number.

    Zero-based page number.

    Default: 0
  • sizestring · min: 1 · max: 500

    Number of items per page.

    Number of items per page.

    Default: 50
  • metaIncludestring[] · unique

(BETA) List data sources of an AILake Database instance › Responses

Data sources successfully retrieved

  • dataobject[] · required

    Array of resource items

  • linksobject · required

    Links object for a list response

  • metaobject

    Metadata for a paginated list response

GET /api/v1/ailake/database/instances/{instanceId}/dataSources

(BETA) Add a data source to an AILake Database instance

POST
/api/v1/ailake/database/instances/{instanceId}/dataSources

(BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.

(BETA) Add a data source to an AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Add a data source to an AILake Database instance › Request Body

  • dataSourceIdstring · required

    Identifier for the new data source in metadata-api. Must be unique within the organization.

  • dataSourceNamestring

    Display name for the new data source in metadata-api. Defaults to dataSourceId when omitted.

(BETA) Add a data source to an AILake Database instance › Responses

Data source successfully added

  • dataSourceobject · required

    A single data source association for an AI Lake Database instance

POST /api/v1/ailake/database/instances/{instanceId}/dataSources

(BETA) Remove a data source from an AILake Database instance

DELETE
/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}

(BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.

(BETA) Remove a data source from an AILake Database instance › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

  • dataSourceIdstring · required

    Identifier of the data source to remove.

    Identifier of the data source to remove.

(BETA) Remove a data source from an AILake Database instance › Responses

Data source successfully removed

  • dataSourceIdstring · required

    Identifier of the removed data source in metadata-api.

DELETE /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}

(BETA) List registered AI Lake ObjectStorages

GET
/api/v1/ailake/objectStorages

(BETA) Lists ObjectStorages registered for the organization. Use the returned name as sourceStorageName in CreatePipeTable, or pass storageId to the ProvisionDatabase storageIds list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.

(BETA) List registered AI Lake ObjectStorages › query Parameters

  • pagestring · min: 0

    Zero-based page number.

    Zero-based page number.

    Default: 0
  • sizestring · min: 1 · max: 500

    Number of items per page.

    Number of items per page.

    Default: 50
  • metaIncludestring[] · unique

(BETA) List registered AI Lake ObjectStorages › Responses

AI Lake ObjectStorages successfully retrieved

  • dataobject[] · required

    Array of resource items

  • linksobject · required

    Links object for a list response

  • metaobject

    Metadata for a paginated list response

GET /api/v1/ailake/objectStorages
Export templatesAI Lake - Pipe Tables