OpenAPI definition

Other

Endpoint:/

Convert a geo file to GeoParquet format

POST

/api/v1/actions/customGeoCollection/convert

Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.

Convert a geo file to GeoParquet format › Request Body

locationstring · required
Location of the file in the staging area to convert.

Convert a geo file to GeoParquet format › Responses

Conversion was successful.

locationstring · required
Location of the converted GeoParquet file in the staging area.

Upload a geo collection file to the staging area

POST

/api/v1/actions/customGeoCollection/staging/upload

Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.

Upload a geo collection file to the staging area › Request Body

filestring · required

Upload a geo collection file to the staging area › Responses

Upload was successful.

locationstring · required
Location to use when referencing the uploaded file in subsequent requests.

Import custom geo collection

POST

/api/v1/actions/customGeoCollection/{collectionId}/import

Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).

Import custom geo collection › path Parameters

collectionIdstring · required

Import custom geo collection › Request Body

locationstring · required
Location of the file in the staging area.

Import custom geo collection › Responses

Successful import.

versioninteger · int32 · required
The version of the imported geo collection.

(BETA) Collect physical table and column statistics from a StarRocks data source

POST

/api/v1/actions/dataSources/{dataSourceId}/scanStatistics

(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values.

(BETA) Collect physical table and column statistics from a StarRocks data source › path Parameters

dataSourceIdstring · required

(BETA) Collect physical table and column statistics from a StarRocks data source › Request Body

schematastring[] · required

tableNamesstring[]

(BETA) Collect physical table and column statistics from a StarRocks data source › Responses

tablesobject[] · required
warningsobject[] · required

Set Certification

POST

/api/v1/actions/workspaces/{workspaceId}/setCertification

Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.

Set Certification › path Parameters

workspaceIdstring · required

Set Certification › Request Body

idstring · required
ID of the entity.
Example: total-sales
typestring · enum · required
Type of the entity.
Enum values:
metric
visualizationObject
analyticalDashboard

messagestring | null
Optional message associated with the certification.
statusstring | null · enum
Certification status of the entity.
Enum values:
CERTIFIED

Set Certification › Responses

No Content

No data returned

Get Skills

GET

/api/v1/ai/agent/skills

Get Skills › Responses

Successful Response

descriptionstring · required
examplesstring[] · required
namestring · required
tagsstring[] · required
titlestring · required

Get Conversations

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations

Get Conversations › path Parameters

workspace_idstring · required

Get Conversations › query Parameters

isPreviewboolean
Default: false
pageinteger · min: 0
Default: 0
sizeinteger · min: 1 · max: 100
Default: 20

Get Conversations › Responses

Successful Response

dataobject[] · required
metaobject · required

Post Conversations

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations

Post Conversations › path Parameters

workspace_idstring · required

Post Conversations › query Parameters

isPreviewboolean
Default: false

Post Conversations › Request Body

agentId

Post Conversations › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

agentId
Identifier of the agent bound to this conversation (if any).
isPreviewboolean
Whether this is a preview conversation.
Default: false
pinnedboolean
Whether this conversation is pinned by the user.
Default: false
title
Conversation title.

Get Conversation

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}

Get Conversation › path Parameters

workspace_idstring · required
conversation_idstring · required

Get Conversation › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

agentId
Identifier of the agent bound to this conversation (if any).
isPreviewboolean
Whether this is a preview conversation.
Default: false
pinnedboolean
Whether this conversation is pinned by the user.
Default: false
title
Conversation title.

Delete Conversation

DELETE

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}

Delete Conversation › path Parameters

workspace_idstring · required
conversation_idstring · required

Delete Conversation › Responses

Successful Response

No data returned

Patch Conversation

PATCH

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}

Patch Conversation › path Parameters

workspace_idstring · required
conversation_idstring · required

Patch Conversation › Request Body

pinned
title

Patch Conversation › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

agentId
Identifier of the agent bound to this conversation (if any).
isPreviewboolean
Whether this is a preview conversation.
Default: false
pinnedboolean
Whether this conversation is pinned by the user.
Default: false
title
Conversation title.

Post Feedback

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/feedback

Post Feedback › path Parameters

workspace_idstring · required
conversation_idstring · required

Post Feedback › Request Body

feedbackrequired
responseIdstring · minLength: 1 · required

Post Feedback › Responses

Successful Response

No data returned

Post Generate Conversation Title

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/generateTitle

Post Generate Conversation Title › path Parameters

workspace_idstring · required
conversation_idstring · required

Post Generate Conversation Title › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

agentId
Identifier of the agent bound to this conversation (if any).
isPreviewboolean
Whether this is a preview conversation.
Default: false
pinnedboolean
Whether this conversation is pinned by the user.
Default: false
title
Conversation title.

Get Conversation Items

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/items

Get Conversation Items › path Parameters

workspace_idstring · required
conversation_idstring · required

Get Conversation Items › Responses

Successful Response

itemsobject[] · required
Ordered list of conversation items.

Post Messages

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/messages

Post Messages › path Parameters

workspace_idstring · required
conversation_idstring · required

Post Messages › Request Body

itemobject · required

options
userContext

Post Messages › Responses

SSE stream with response_started/item/response_ended events

No data returned

Get Conversation Responses

GET

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/responses

Get Conversation Responses › path Parameters

workspace_idstring · required
conversation_idstring · required

Get Conversation Responses › Responses

Successful Response

responsesobject[] · required
Conversation responses.

Patch Response

PATCH

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/responses/{response_id}

Patch Response › path Parameters

workspace_idstring · required
conversation_idstring · required
response_idstring · required

Patch Response › Request Body

feedbackrequired

Patch Response › Responses

Successful Response

No data returned

Switch the active agent on an existing conversation

POST

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/switchAgent

Switch the active agent on an existing conversation › path Parameters

workspace_idstring · required
conversation_idstring · required

Switch the active agent on an existing conversation › Request Body

agentIdstring · required

Switch the active agent on an existing conversation › Responses

Successful Response

conversationIdstring · required
Conversation identifier.
createdAtstring · required
Conversation creation timestamp (ISO-8601 UTC).
lastActivityAtstring · required
Last activity timestamp (ISO-8601 UTC).
organizationIdstring · required
Organization identifier.
userIdstring · required
Owner user identifier.
workspaceIdstring · required
Workspace identifier.

agentId
Identifier of the agent bound to this conversation (if any).
isPreviewboolean
Whether this is a preview conversation.
Default: false
pinnedboolean
Whether this conversation is pinned by the user.
Default: false
title
Conversation title.

Patch Visualization

PATCH

/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/visualizations/{visualization_id}

Patch Visualization › path Parameters

workspace_idstring · required
conversation_idstring · required
visualization_idstring · required

Patch Visualization › Request Body

idstring · minLength: 1 · required

Patch Visualization › Responses

Successful Response

No data returned

(EXPERIMENTAL) Summarize a dashboard

POST

/api/v1/ai/workspaces/{workspace_id}/summary

Note: This API is an experimental and is going to change. Please, use it accordingly. Generates a natural-language summary of a dashboard's visualizations, optionally scoped by an explicit filter context.

(EXPERIMENTAL) Summarize a dashboard › path Parameters

workspace_idstring · required

(EXPERIMENTAL) Summarize a dashboard › Request Body

dashboardIdstring · minLength: 1 · required

filterContext
AFM filters in the same shape consumed by the AFM execute endpoint, merged on top of each visualization's stored filters using the type-aware merge rules. Omit or send null to fall back to the dashboard's saved filter context. Send [] to explicitly apply no request filters.
formatHint
tabId
Local identifier of the dashboard tab to summarize. When the dashboard has tabs and tabId is omitted, the first tab is used (matching the UI's default tab). A tabId that does not match any tab's localIdentifier returns 404. Supplying tabId for a dashboard without tabs returns 400. When tabId is combined with visualizations, every supplied visualization must belong to the selected tab; otherwise the request returns 400.
visualizations

(EXPERIMENTAL) Summarize a dashboard › Responses

Successful Response

filterContextarray · required
generatedAtstring · date-time · required
summarystring · required
visualizationsExcludedobject[] · required
visualizationsIncludedobject[] · required

tabId

Get all Agent entities

GET

/api/v1/entities/agents

Get all Agent entities › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
userGroups
createdBy
modifiedBy
ALL
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
page
all
ALL

Get all Agent entities › Responses

Request successfully processed

dataobject[] · unique · required

includedarray · unique
Included resources
linksobject
metaobject

Post Agent entities

POST

/api/v1/entities/agents

AI Agent - behavior configuration for AI assistants

Post Agent entities › query Parameters

includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
userGroups
createdBy
modifiedBy
ALL

Post Agent entities › Request Body

dataobject · required
JSON:API representation of agent entity.

Post Agent entities › Responses

Request successfully processed

dataobject · required
JSON:API representation of agent entity.

includedarray · unique
Included resources
linksobject

Get Agent entity

GET

/api/v1/entities/agents/{id}

Get Agent entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Agent entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
userGroups
createdBy
modifiedBy
ALL

Get Agent entity › Responses

Request successfully processed

dataobject · required
JSON:API representation of agent entity.

includedarray · unique
Included resources
linksobject

Put Agent entity

PUT

/api/v1/entities/agents/{id}

Put Agent entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Agent entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
userGroups
createdBy
modifiedBy
ALL

Put Agent entity › Request Body

dataobject · required
JSON:API representation of agent entity.

Put Agent entity › Responses

Request successfully processed

dataobject · required
JSON:API representation of agent entity.

includedarray · unique
Included resources
linksobject

Delete Agent entity

DELETE

/api/v1/entities/agents/{id}

Delete Agent entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Agent entity › Responses

Successfully deleted

No data returned

Patch Agent entity

PATCH

/api/v1/entities/agents/{id}

Patch Agent entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Agent entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
includestring[] · style: form
Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.
Enum values:
userIdentifiers
userGroups
createdBy
modifiedBy
ALL

Patch Agent entity › Request Body

dataobject · required
JSON:API representation of patching agent entity.

Patch Agent entity › Responses

Request successfully processed

dataobject · required
JSON:API representation of agent entity.

includedarray · unique
Included resources
linksobject

Get all Custom Geo Collections

GET

/api/v1/entities/customGeoCollections

Get all Custom Geo Collections › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
page
all
ALL

Get all Custom Geo Collections › Responses

Request successfully processed

dataobject[] · unique · required

linksobject
metaobject

Post Custom Geo Collections

POST

/api/v1/entities/customGeoCollections

Post Custom Geo Collections › Request Body

dataobject · required
JSON:API representation of customGeoCollection entity.

Post Custom Geo Collections › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Get Custom Geo Collection

GET

/api/v1/entities/customGeoCollections/{id}

Get Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Custom Geo Collection › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Custom Geo Collection › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Put Custom Geo Collection

PUT

/api/v1/entities/customGeoCollections/{id}

Put Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Custom Geo Collection › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put Custom Geo Collection › Request Body

dataobject · required
JSON:API representation of customGeoCollection entity.

Put Custom Geo Collection › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Delete Custom Geo Collection

DELETE

/api/v1/entities/customGeoCollections/{id}

Delete Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Custom Geo Collection › Responses

Successfully deleted

No data returned

Patch Custom Geo Collection

PATCH

/api/v1/entities/customGeoCollections/{id}

Patch Custom Geo Collection › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Custom Geo Collection › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch Custom Geo Collection › Request Body

dataobject · required
JSON:API representation of patching customGeoCollection entity.

Patch Custom Geo Collection › Responses

Request successfully processed

dataobject · required
JSON:API representation of customGeoCollection entity.

linksobject

Get all LLM Provider entities

GET

/api/v1/entities/llmProviders

Get all LLM Provider entities › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
pageinteger
Zero-based page index (0..N)
Default: 0
sizeinteger
The size of the page to be returned
Default: 20
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
metaIncludestring[] · unique · style: form
Include Meta objects.
Included meta objects
Enum values:
page
all
ALL

Get all LLM Provider entities › Responses

Request successfully processed

dataobject[] · unique · required

linksobject
metaobject

Post LLM Provider entities

POST

/api/v1/entities/llmProviders

LLM Provider - connection configuration for LLM services

Post LLM Provider entities › Request Body

dataobject · required
LLM Provider configuration for connecting to LLM services.

Post LLM Provider entities › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

Get LLM Provider entity

GET

/api/v1/entities/llmProviders/{id}

Get LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get LLM Provider entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get LLM Provider entity › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

PUT LLM Provider entity

PUT

/api/v1/entities/llmProviders/{id}

PUT LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

PUT LLM Provider entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

PUT LLM Provider entity › Request Body

dataobject · required
LLM Provider configuration for connecting to LLM services.

PUT LLM Provider entity › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

Delete LLM Provider entity

DELETE

/api/v1/entities/llmProviders/{id}

Delete LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete LLM Provider entity › Responses

Successfully deleted

No data returned

Patch LLM Provider entity

PATCH

/api/v1/entities/llmProviders/{id}

Patch LLM Provider entity › path Parameters

idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch LLM Provider entity › query Parameters

filterstring
Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch LLM Provider entity › Request Body

dataobject · required
LLM Provider configuration for connecting to LLM services.

Patch LLM Provider entity › Responses

Request successfully processed

dataobject · required
LLM Provider configuration for connecting to LLM services.

linksobject

(BETA) Retrieve stored physical statistics for a data source

GET

/api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.

(BETA) Retrieve stored physical statistics for a data source › path Parameters

dataSourceIdstring · required

(BETA) Retrieve stored physical statistics for a data source › query Parameters

schemaNamestring
tableNamestring

(BETA) Retrieve stored physical statistics for a data source › Responses

tablesobject[] · required

(BETA) Store physical table and column statistics for a data source

PUT

/api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.

(BETA) Store physical table and column statistics for a data source › path Parameters

dataSourceIdstring · required

(BETA) Store physical table and column statistics for a data source › Request Body

tablesobject[] · required

(BETA) Store physical table and column statistics for a data source › Responses

Statistics stored successfully.

No data returned

(BETA) Delete stored physical statistics for a data source

DELETE

/api/v1/layout/dataSources/{dataSourceId}/statistics

(BETA) Removes all stored physical statistics for the specified data source.

(BETA) Delete stored physical statistics for a data source › path Parameters

dataSourceIdstring · required

(BETA) Delete stored physical statistics for a data source › Responses

Statistics deleted.

No data returned

Get user data filters

GET

/api/v1/layout/workspaces/{workspaceId}/userDataFilters

Retrieve current user data filters assigned to the workspace.

Get user data filters › path Parameters

workspaceIdstring · required

Get user data filters › Responses

Retrieved current user data filters.

userDataFiltersobject[] · required

Set user data filters

PUT

/api/v1/layout/workspaces/{workspaceId}/userDataFilters

Set user data filters assigned to the workspace.

Set user data filters › path Parameters

workspaceIdstring · required

Set user data filters › Request Body

userDataFiltersobject[] · required

Set user data filters › Responses

User data filters successfully set.

No data returned

Get collection features

GET

/api/v1/location/collections/{collectionId}/items

Retrieve features from a GeoCollections collection as GeoJSON

Get collection features › path Parameters

collectionIdstring · required
Collection identifier

Get collection features › query Parameters

limitinteger · min: 1 · max: 100
Maximum number of features to return
bboxstring
Bounding box filter (minx,miny,maxx,maxy)
valuesstring[]
List of values to filter features by

Get collection features › Responses

Features retrieved successfully

featuresobject[] · required
typestring · required

bboxnumber[]

Get custom collection features

GET

/api/v1/location/custom/collections/{collectionId}/items

Retrieve features from a custom (organization-scoped) GeoCollections collection as GeoJSON

Get custom collection features › path Parameters

collectionIdstring · required
Collection identifier

Get custom collection features › query Parameters

limitinteger · min: 1 · max: 100
Maximum number of features to return
bboxstring
Bounding box filter (minx,miny,maxx,maxy)
valuesstring[]
List of values to filter features by

Get custom collection features › Responses

Features retrieved successfully

featuresobject[] · required
typestring · required

bboxnumber[]

Agents