Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
    Usage
    Computation
    Smart Functions
      Validate LLM EndpointpostValidate LLM Endpoint By IdpostGet Analytics Catalog CreatedBy UsersgetGet Analytics Catalog Tagsget(BETA) Chat with AIpost(BETA) Get Chat Historypost(BETA) Chat with AIpostGet Chat UsagegetGet Quality IssuesgetGet Quality Issues Calculation StatusgetTrigger Quality Issues CalculationpostGet AI Memory CreatedBy UsersgetGet Active LLM Endpoints for this workspaceget(BETA) Semantic Search in Metadatapost(EXPERIMENTAL) Smart functions - Anomaly Detection Resultget(EXPERIMENTAL) Smart functions - Anomaly Detectionpost(EXPERIMENTAL) Smart functions - Clustering Resultget(EXPERIMENTAL) Smart functions - Clusteringpost(BETA) Smart functions - Forecast Resultget(BETA) Smart functions - Forecastpost
    Entitlement
    Reporting - Settings
    Cache usage
    LLM Endpoints
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Smart Functions (3.51)

Endpoint:/

Validate LLM Endpoint

POST
/api/v1/actions/ai/llmEndpoint/test

Validates LLM endpoint with provided parameters.

Validate LLM Endpoint › Request Body

  • providerstring · required

    Provider for the LLM endpoint validation

  • tokenstring · required

    Token for the LLM endpoint validation

  • baseUrlstring

    Base URL for the LLM endpoint validation

  • llmModelstring

    LLM model for the LLM endpoint validation

  • llmOrganizationstring

    Organization name for the LLM endpoint validation

Validate LLM Endpoint › Responses

OK

  • messagestring · required

    Additional message about the LLM endpoint validation

  • successfulboolean · required

    Whether the LLM endpoint validation was successful

POST /api/v1/actions/ai/llmEndpoint/test

Validate LLM Endpoint By Id

POST
/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test

Validates existing LLM endpoint with provided parameters and updates it if they are valid.

Validate LLM Endpoint By Id › path Parameters

  • llmEndpointIdstring · required

Validate LLM Endpoint By Id › Request Body

  • baseUrlstring

    Base URL for the LLM endpoint validation

  • llmModelstring

    LLM model for the LLM endpoint validation

  • llmOrganizationstring

    Organization name for the LLM endpoint validation

  • providerstring

    Provider for the LLM endpoint validation

  • tokenstring

    Token for the LLM endpoint validation

Validate LLM Endpoint By Id › Responses

OK

  • messagestring · required

    Additional message about the LLM endpoint validation

  • successfulboolean · required

    Whether the LLM endpoint validation was successful

POST /api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test

Get Analytics Catalog CreatedBy Users

GET
/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy

Returns a list of Users who created any object for this workspace

Get Analytics Catalog CreatedBy Users › path Parameters

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

    Workspace identifier

Get Analytics Catalog CreatedBy Users › Responses

OK

  • reasoningstring · required

    Reasoning for error states

  • usersobject[] · required

    Users who created any object in the catalog

GET /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy

Get Analytics Catalog Tags

GET
/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags

Returns a list of tags for this workspace

Get Analytics Catalog Tags › path Parameters

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

    Workspace identifier

Get Analytics Catalog Tags › Responses

OK

  • tagsstring[] · required
GET /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags

(BETA) Chat with AI

POST
/api/v1/actions/workspaces/{workspaceId}/ai/chat

(BETA) Combines multiple use cases such as search, create visualizations, ...

(BETA) Chat with AI › path Parameters

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

    Workspace identifier

(BETA) Chat with AI › Request Body

  • questionstring · maxLength: 2000 · required

    User question

  • includeHiddenboolean

    If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.

    Default: false
  • limitCreateinteger · int32

    Maximum number of created results.

    Default: 3
  • limitCreateContextinteger · int32

    Maximum number of relevant objects included into context for LLM (for each object type).

    Default: 10
  • limitSearchinteger · int32

    Maximum number of search results.

    Default: 5
  • objectTypesstring[]

    List of object types to filter the search and visualization building. If empty or null, all object types are considered.

    Enum values:
    attribute
    metric
    fact
    label
    date
    dataset
    visualization
    dashboard
  • relevantScoreThresholdnumber · double

    Score, above which we return found objects. Below this score objects are not relevant.

    Default: 0.45
  • searchScoreThresholdnumber · double

    Score, above which we return found object(s) and don't call LLM to create new objects.

    Default: 0.9
  • threadIdSuffixstring

    Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

  • titleToDescriptorRationumber · double

    Temporary for experiments. Ratio of title score to descriptor score.

    Default: 0.7
  • userContextobject

    User context, which can affect the behavior of the underlying AI features.

(BETA) Chat with AI › Responses

OK

  • changeAnalysisParamsobject

    Change analysis specification.

  • chatHistoryInteractionIdstring

    Chat History interaction ID. Unique ID for each interaction.

  • createdVisualizationsobject

    Visualization definitions created by AI.

  • errorResponsestring

    Error response in anything fails.

  • foundObjectsobject

    List of objects found by similarity search and post-processed by LLM.

  • reasoningobject

    Reasoning wrapper containing steps taken during request handling.

  • routingobject

    Question -> Use Case routing. May contain final answer is a special use case is not required.

  • semanticSearchobject
  • textResponsestring

    Text response for general questions.

  • threadIdSuffixstring

    Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

POST /api/v1/actions/workspaces/{workspaceId}/ai/chat

(BETA) Get Chat History

POST
/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory

(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.

(BETA) Get Chat History › path Parameters

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

    Workspace identifier

(BETA) Get Chat History › Request Body

  • chatHistoryInteractionIdstring

    Return chat history records only after this interaction ID. If empty, complete chat history is returned.

  • resetboolean

    User feedback.

  • responseStatestring · enum

    Response state indicating the outcome of the AI interaction.

    Enum values:
    SUCCESSFUL
    UNEXPECTED_ERROR
    NOT_FOUND_ATTRIBUTES
    TOO_MANY_DATA_POINTS
    NO_DATA
    NO_RESULTS
    OUT_OF_TOPIC
  • savedVisualizationobject

    Created and saved visualization IDs.

  • threadIdSuffixstring

    Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

  • userFeedbackstring · enum

    User feedback.

    Enum values:
    POSITIVE
    NEGATIVE
    NONE
  • userTextFeedbackstring

    User text feedback for the interaction.

(BETA) Get Chat History › Responses

OK

  • interactionsobject[] · required

    List of chat history interactions.

  • threadIdstring · required

    The conversation thread ID.

POST /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory

(BETA) Chat with AI

POST
/api/v1/actions/workspaces/{workspaceId}/ai/chatStream

(BETA) Combines multiple use cases such as search, create visualizations, ...

(BETA) Chat with AI › path Parameters

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

    Workspace identifier

(BETA) Chat with AI › Request Body

  • questionstring · maxLength: 2000 · required

    User question

  • includeHiddenboolean

    If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.

    Default: false
  • limitCreateinteger · int32

    Maximum number of created results.

    Default: 3
  • limitCreateContextinteger · int32

    Maximum number of relevant objects included into context for LLM (for each object type).

    Default: 10
  • limitSearchinteger · int32

    Maximum number of search results.

    Default: 5
  • objectTypesstring[]

    List of object types to filter the search and visualization building. If empty or null, all object types are considered.

    Enum values:
    attribute
    metric
    fact
    label
    date
    dataset
    visualization
    dashboard
  • relevantScoreThresholdnumber · double

    Score, above which we return found objects. Below this score objects are not relevant.

    Default: 0.45
  • searchScoreThresholdnumber · double

    Score, above which we return found object(s) and don't call LLM to create new objects.

    Default: 0.9
  • threadIdSuffixstring

    Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

  • titleToDescriptorRationumber · double

    Temporary for experiments. Ratio of title score to descriptor score.

    Default: 0.7
  • userContextobject

    User context, which can affect the behavior of the underlying AI features.

(BETA) Chat with AI › Responses

OK

POST /api/v1/actions/workspaces/{workspaceId}/ai/chatStream

Get Chat Usage

GET
/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage

Returns usage statistics of chat for a user in a workspace.

Get Chat Usage › path Parameters

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

    Workspace identifier

Get Chat Usage › Responses

OK

  • interactionCountinteger · int32 · required

    Number of interactions in the time window

  • interactionLimitinteger · int32 · required

    Maximum number of interactions in the time window any user can do in the workspace

  • timeWindowHoursinteger · int32 · required

    Time window in hours

GET /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage

Get Quality Issues

GET
/api/v1/actions/workspaces/{workspaceId}/ai/issues

Returns metadata quality issues detected by the platform linter.

Get Quality Issues › path Parameters

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

    Workspace identifier

Get Quality Issues › Responses

OK

  • issuesobject[] · required

    List of quality issues found in the workspace

  • statusstring · enum · required

    Status of the latest triggered quality check process

    Enum values:
    RUNNING
    COMPLETED
    FAILED
    NOT_FOUND
    DISABLED
  • updatedAtstring

    Timestamp when the quality issues were last updated (ISO format)

GET /api/v1/actions/workspaces/{workspaceId}/ai/issues

Get Quality Issues Calculation Status

GET
/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}

Returns the status of a quality issues calculation process identified by process ID.

Get Quality Issues Calculation Status › path Parameters

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

    Workspace identifier

  • processIdstring · required

Get Quality Issues Calculation Status › Responses

OK

  • statusstring · enum · required

    Current status of the calculation

    Enum values:
    RUNNING
    COMPLETED
    FAILED
    NOT_FOUND
    DISABLED
  • errorstring

    Error message (available when status is FAILED or NOT_FOUND)

  • issuesobject[]

    List of quality issues (available when status is COMPLETED)

GET /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}

Trigger Quality Issues Calculation

POST
/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck

Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.

Trigger Quality Issues Calculation › path Parameters

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

    Workspace identifier

Trigger Quality Issues Calculation › Responses

OK

  • processIdstring · required

    Process ID for tracking the calculation status

  • statusstring · enum · required

    Current status of the calculation

    Enum values:
    RUNNING
    COMPLETED
    FAILED
    DISABLED
POST /api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck

Get AI Memory CreatedBy Users

GET
/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy

Returns a list of Users who created any memory item for this workspace

Get AI Memory CreatedBy Users › path Parameters

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

    Workspace identifier

Get AI Memory CreatedBy Users › Responses

OK

  • reasoningstring · required

    Reasoning for error states

  • usersobject[] · required

    Users who created memory item

GET /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy

Get Active LLM Endpoints for this workspace

GET
/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints

Returns a list of available LLM Endpoints

Get Active LLM Endpoints for this workspace › path Parameters

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

    Workspace identifier

Get Active LLM Endpoints for this workspace › Responses

OK

  • dataobject[] · required
GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints

(BETA) Semantic Search in Metadata

POST
/api/v1/actions/workspaces/{workspaceId}/ai/search

(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.

(BETA) Semantic Search in Metadata › path Parameters

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

    Workspace identifier

(BETA) Semantic Search in Metadata › Request Body

  • questionstring · maxLength: 1000 · required

    Keyword/sentence is input for search.

  • deepSearchboolean

    Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.

    Default: false
  • includeHiddenboolean

    If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.

    Default: false
  • limitinteger · int32

    Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.

    Default: 10
  • objectTypesstring[]

    List of object types to search for.

    Enum values:
    attribute
    metric
    fact
    label
    date
    dataset
    visualization
    dashboard
  • relevantScoreThresholdnumber · double

    Score, above which we return found objects. Below this score objects are not relevant.

    Default: 0.3
  • titleToDescriptorRationumber · double

    Temporary for experiments. Ratio of title score to descriptor score.

    Default: 0.7

(BETA) Semantic Search in Metadata › Responses

OK

  • reasoningstring · required

    DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.

  • relationshipsobject[] · required
  • resultsobject[] · required
POST /api/v1/actions/workspaces/{workspaceId}/ai/search

(EXPERIMENTAL) Smart functions - Anomaly Detection Result

GET
/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}

(EXPERIMENTAL) Gets anomalies.

(EXPERIMENTAL) Smart functions - Anomaly Detection Result › path Parameters

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

    Workspace identifier

  • resultIdstring · required

    Result ID

(EXPERIMENTAL) Smart functions - Anomaly Detection Result › query Parameters

  • offsetinteger · int32
  • limitinteger · int32

(EXPERIMENTAL) Smart functions - Anomaly Detection Result › Responses

OK

  • anomalyFlag(boolean | null)[] · required
  • attributestring[] · required
  • values(number | null)[] · required
GET /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}

(EXPERIMENTAL) Smart functions - Anomaly Detection

POST
/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}

(EXPERIMENTAL) Computes anomaly detection.

(EXPERIMENTAL) Smart functions - Anomaly Detection › path Parameters

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

    Workspace identifier

  • resultIdstring · required

    Input result ID to be used in the computation

(EXPERIMENTAL) Smart functions - Anomaly Detection › Headers

  • skip-cacheboolean

    Ignore all caches during execution of current request.

    Default: false

(EXPERIMENTAL) Smart functions - Anomaly Detection › Request Body

  • sensitivitynumber · float · required

    Anomaly detection sensitivity.

(EXPERIMENTAL) Smart functions - Anomaly Detection › Responses

OK

  • linksobject · required

    Links to the execution result.

POST /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}

(EXPERIMENTAL) Smart functions - Clustering Result

GET
/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}

(EXPERIMENTAL) Gets clustering result.

(EXPERIMENTAL) Smart functions - Clustering Result › path Parameters

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

    Workspace identifier

  • resultIdstring · required

    Result ID

(EXPERIMENTAL) Smart functions - Clustering Result › query Parameters

  • offsetinteger · int32
  • limitinteger · int32

(EXPERIMENTAL) Smart functions - Clustering Result › Responses

OK

  • attributeobject[] · required
  • clusters(integer | null)[] · required
  • xcoordnumber[] · required
  • ycoordnumber[] · required
  • xCoord(number | null)[] · writeOnly
  • yCoord(number | null)[] · writeOnly
GET /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}

(EXPERIMENTAL) Smart functions - Clustering

POST
/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}

(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.

(EXPERIMENTAL) Smart functions - Clustering › path Parameters

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

    Workspace identifier

  • resultIdstring · required

    Input result ID to be used in the computation

(EXPERIMENTAL) Smart functions - Clustering › Headers

  • skip-cacheboolean

    Ignore all caches during execution of current request.

    Default: false

(EXPERIMENTAL) Smart functions - Clustering › Request Body

  • numberOfClustersinteger · int32 · min: 1 · required

    Number of clusters to create

  • thresholdnumber · double

    Threshold used for algorithm

    Default: 0.03

(EXPERIMENTAL) Smart functions - Clustering › Responses

OK

  • linksobject · required

    Links to the execution result.

POST /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}

(BETA) Smart functions - Forecast Result

GET
/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}

(BETA) Gets forecast result.

(BETA) Smart functions - Forecast Result › path Parameters

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

    Workspace identifier

  • resultIdstring · required

    Result ID

(BETA) Smart functions - Forecast Result › query Parameters

  • offsetinteger · int32
  • limitinteger · int32

(BETA) Smart functions - Forecast Result › Responses

OK

  • attributestring[] · required
  • lowerBound(number | null)[] · required
  • origin(number | null)[] · required
  • prediction(number | null)[] · required
  • upperBound(number | null)[] · required
GET /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}

(BETA) Smart functions - Forecast

POST
/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}

(BETA) Computes forecasted data points from the provided execution result and parameters.

(BETA) Smart functions - Forecast › path Parameters

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

    Workspace identifier

  • resultIdstring · required

    Input result ID to be used in the computation

(BETA) Smart functions - Forecast › Headers

  • skip-cacheboolean

    Ignore all caches during execution of current request.

    Default: false

(BETA) Smart functions - Forecast › Request Body

  • forecastPeriodinteger · int32 · required

    Number of future periods that should be forecasted

  • confidenceLevelnumber · float

    Confidence interval boundary value.

    Default: 0.95
  • seasonalboolean

    Whether the input data is seasonal

    Default: false

(BETA) Smart functions - Forecast › Responses

OK

  • linksobject · required

    Links to the execution result.

POST /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}
ComputationEntitlement