AI admin queries schema

service.ai.graphqls, service.ai.mcp.graphqls

Some of the operations on this page are available in Enterprise, AWS and GCP editions only.

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

aiChatConversationInfo

Description

Returns AI chat conversation info for the specified conversation ID.

Response

Returns an AIChatConversationInfo!

Arguments
Name Description
conversationId - ID!
loadMetrics - Boolean

Example

Query
query aiChatConversationInfo(
  $conversationId: ID!,
  $loadMetrics: Boolean
) {
  aiChatConversationInfo(
    conversationId: $conversationId,
    loadMetrics: $loadMetrics
  ) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    promptGeneratorId
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
    waitingForResponse
    metrics {
      ...AIChatConversationMetricsFragment
    }
    profile
  }
}
Variables
{"conversationId": "<id>", "loadMetrics": "<boolean>"}
Response
{
  "data": {
    "aiChatConversationInfo": {
      "dataSourceId": DataSourceId,
      "id": "<id>",
      "promptGeneratorId": "<id>",
      "caption": "<string>",
      "time": "<datetime>",
      "messages": [AIMessage],
      "settings": AIChatConversationSettings,
      "waitingForResponse": "<boolean>",
      "metrics": AIChatConversationMetrics,
      "profile": "<id>"
    }
  }
}
Queries

aiDataSourceSettings

Description

Returns AI settings for the specified connection.

Response

Returns an AIDataSourceSettingsInfo!

Arguments
Name Description
dataSourceId - DataSourceIdInput!

Example

Query
query aiDataSourceSettings($dataSourceId: DataSourceIdInput!) {
  aiDataSourceSettings(dataSourceId: $dataSourceId) {
    metaTransferConfirmed
    scope
    customObjectIds
    mcpEnabled
    mcpEndpoint
  }
}
Variables
{"dataSourceId": DataSourceIdInput}
Response
{
  "data": {
    "aiDataSourceSettings": {
      "metaTransferConfirmed": "<boolean>",
      "scope": "CURRENT_SCHEMA",
      "customObjectIds": ["<id>"],
      "mcpEnabled": "<boolean>",
      "mcpEndpoint": "<string>"
    }
  }
}
Queries

aiListChatConversations

Description

Returns list of AI chat conversations for the specified connection.

Response

Returns [AIChatConversationInfo!]!

Arguments
Name Description
dataSourceId - DataSourceIdInput

Example

Query
query aiListChatConversations($dataSourceId: DataSourceIdInput) {
  aiListChatConversations(dataSourceId: $dataSourceId) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    promptGeneratorId
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
    waitingForResponse
    metrics {
      ...AIChatConversationMetricsFragment
    }
    profile
  }
}
Variables
{"dataSourceId": DataSourceIdInput}
Response
{
  "data": {
    "aiListChatConversations": [
      {
        "dataSourceId": DataSourceId,
        "id": "<id>",
        "promptGeneratorId": "<id>",
        "caption": "<string>",
        "time": "<datetime>",
        "messages": [AIMessage],
        "settings": AIChatConversationSettings,
        "waitingForResponse": "<boolean>",
        "metrics": AIChatConversationMetrics,
        "profile": "<id>"
      }
    ]
  }
}
Queries

aiListEngineProperties

Description

Returns the properties of the specified AI engine for displaying it in the UI. In case settings are passed, fills it with defaults and returns back.

Response

Returns [ObjectPropertyInfo!]!

Arguments
Name Description
engineId - ID!
profileId - ID
settings - AIEngineConfig

Example

Query
query aiListEngineProperties(
  $engineId: ID!,
  $profileId: ID,
  $settings: AIEngineConfig
) {
  aiListEngineProperties(
    engineId: $engineId,
    profileId: $profileId,
    settings: $settings
  ) {
    id
    displayName
    description
    hint
    category
    dataType
    value
    validValues
    defaultValue
    length
    features
    order
    supportedConfigurationTypes
    required
    scopes
    conditions {
      ...ConditionFragment
    }
  }
}
Variables
{
  "engineId": "<id>",
  "profileId": "<id>",
  "settings": AIEngineConfig
}
Response
{
  "data": {
    "aiListEngineProperties": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "description": "<string>",
        "hint": "<string>",
        "category": "<string>",
        "dataType": "<string>",
        "value": "<object>",
        "validValues": ["<object>"],
        "defaultValue": "<object>",
        "length": "TINY",
        "features": ["<string>"],
        "order": "<int>",
        "supportedConfigurationTypes": ["<string>"],
        "required": "<boolean>",
        "scopes": ["<string>"],
        "conditions": [Condition]
      }
    ]
  }
}
Queries

aiListEngines

Description

Returns the list of available AI engines.

Response

Returns [AIEngineInfo!]

Example

Query
query aiListEngines {
  aiListEngines {
    id
    name
  }
}
Response
{"data": {"aiListEngines": [{"id": "<id>", "name": "<string>"}]}}
Queries

aiListFunctions

Description

Return the list of available AI functions.

Response

Returns [AIFunction!]

Example

Query
query aiListFunctions {
  aiListFunctions {
    id
    name
    description
    icon
    system
  }
}
Response
{
  "data": {
    "aiListFunctions": [
      {
        "id": "<id>",
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "system": "<boolean>"
      }
    ]
  }
}
Queries

aiListProfiles

Description

Returns the list of available AI engine configuration profiles.

Response

Returns [AIConfigurationProfileInfo!]!

Example

Query
query aiListProfiles {
  aiListProfiles {
    id
    name
    engineId
  }
}
Response
{
  "data": {
    "aiListProfiles": [{"id": "<id>", "name": "<string>", "engineId": "<id>"}]
  }
}
Queries

aiSettings

Description

Returns the global AI settings.

Response

Returns an AISettingsInfo!

Example

Query
query aiSettings {
  aiSettings {
    activeEngine
    defaultConfiguration
    language
  }
}
Response
{
  "data": {
    "aiSettings": {
      "activeEngine": "<id>",
      "defaultConfiguration": "<id>",
      "language": "<string>"
    }
  }
}
Queries

aiToolsSettings

Description
Available in Enterprise, AWS and GCP editions only.

Returns available AI tool servers and their tools for administration.

Response

Returns an AIToolsSettingsInfo!

Example

Query
query aiToolsSettings {
  aiToolsSettings {
    servers {
      ...AIToolboxInfoFragment
    }
    functionsEnabled
  }
}
Response
{
  "data": {
    "aiToolsSettings": {
      "servers": [AIToolboxInfo],
      "functionsEnabled": "<boolean>"
    }
  }
}

Mutations

aiClearLastChatMessages

Description

Clears the chat messages in the AI chat conversation. The messages will be removed from the conversation.

Response

Returns a Boolean!

Arguments
Name Description
conversationId - ID!
messageId - ID!

Example

Query
mutation aiClearLastChatMessages(
  $conversationId: ID!,
  $messageId: ID!
) {
  aiClearLastChatMessages(
    conversationId: $conversationId,
    messageId: $messageId
  )
}
Variables
{"conversationId": "<id>", "messageId": "<id>"}
Response
{
  "data": {
    "aiClearLastChatMessages": "<boolean>"
  }
}
Mutations

aiCreateChatConversation

Description

Creates a new AI chat conversation. Conversation is created in the context of a project and connection. If the connection and project are not specified, the conversation will be created without a context.

Response

Returns an AIChatConversationInfo!

Arguments
Name Description
config - AIChatConversationInput!

Example

Query
mutation aiCreateChatConversation($config: AIChatConversationInput!) {
  aiCreateChatConversation(config: $config) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    promptGeneratorId
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
    waitingForResponse
    metrics {
      ...AIChatConversationMetricsFragment
    }
    profile
  }
}
Variables
{"config": AIChatConversationInput}
Response
{
  "data": {
    "aiCreateChatConversation": {
      "dataSourceId": DataSourceId,
      "id": "<id>",
      "promptGeneratorId": "<id>",
      "caption": "<string>",
      "time": "<datetime>",
      "messages": [AIMessage],
      "settings": AIChatConversationSettings,
      "waitingForResponse": "<boolean>",
      "metrics": AIChatConversationMetrics,
      "profile": "<id>"
    }
  }
}
Mutations

aiCreateProfile

Description

Creates a new AI engine configuration profile.

Response

Returns an AIAdminConfigurationProfileInfo!

Arguments
Name Description
config - AIConfigurationProfileInput!

Example

Query
mutation aiCreateProfile($config: AIConfigurationProfileInput!) {
  aiCreateProfile(config: $config) {
    id
    name
    engineId
    configuration {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{"config": AIConfigurationProfileInput}
Response
{
  "data": {
    "aiCreateProfile": {
      "id": "<id>",
      "name": "<string>",
      "engineId": "<id>",
      "configuration": [ObjectPropertyInfo]
    }
  }
}
Mutations

aiDeleteChatConversation

Description

Deletes the specified AI chat conversation

Response

Returns a Boolean!

Arguments
Name Description
conversationId - ID!

Example

Query
mutation aiDeleteChatConversation($conversationId: ID!) {
  aiDeleteChatConversation(conversationId: $conversationId)
}
Variables
{"conversationId": "<id>"}
Response
{
  "data": {
    "aiDeleteChatConversation": "<boolean>"
  }
}
Mutations

aiDeleteProfile

Description

Deletes the specified AI engine configuration profile.

Response

Returns a Boolean!

Arguments
Name Description
profileId - ID!

Example

Query
mutation aiDeleteProfile($profileId: ID!) {
  aiDeleteProfile(profileId: $profileId)
}
Variables
{"profileId": "<id>"}
Response
{"data": {"aiDeleteProfile": "<boolean>"}}
Mutations

aiDeleteToolbox

Description
Available in Enterprise, AWS and GCP editions only.

Deletes MCP server configurations.

Response

Returns [AIToolboxInfo!]!

Arguments
Name Description
toolboxIds - [ID!]!

Example

Query
mutation aiDeleteToolbox($toolboxIds: [ID!]!) {
  aiDeleteToolbox(toolboxIds: $toolboxIds) {
    id
    name
    description
    internal
    enabled
    configuration
    status
    statusMessage
    tools {
      ...AIToolInfoFragment
    }
  }
}
Variables
{"toolboxIds": "<id>"}
Response
{
  "data": {
    "aiDeleteToolbox": [
      {
        "id": "<id>",
        "name": "<string>",
        "description": "<string>",
        "internal": "<boolean>",
        "enabled": "<boolean>",
        "configuration": "<object>",
        "status": "AVAILABLE",
        "statusMessage": "<string>",
        "tools": [AIToolInfo]
      }
    ]
  }
}
Mutations

aiSaveDataSourceSettings

Description

Saves AI settings (e.g. supporting confirming metadata transfer) for the specified connection.

Response

Returns an AIDataSourceSettingsInfo!

Arguments
Name Description
dataSourceId - DataSourceIdInput!
settings - AIDataSourceSettingsInput!

Example

Query
mutation aiSaveDataSourceSettings(
  $dataSourceId: DataSourceIdInput!,
  $settings: AIDataSourceSettingsInput!
) {
  aiSaveDataSourceSettings(
    dataSourceId: $dataSourceId,
    settings: $settings
  ) {
    metaTransferConfirmed
    scope
    customObjectIds
    mcpEnabled
    mcpEndpoint
  }
}
Variables
{
  "dataSourceId": DataSourceIdInput,
  "settings": AIDataSourceSettingsInput
}
Response
{
  "data": {
    "aiSaveDataSourceSettings": {
      "metaTransferConfirmed": "<boolean>",
      "scope": "CURRENT_SCHEMA",
      "customObjectIds": ["<id>"],
      "mcpEnabled": "<boolean>",
      "mcpEndpoint": "<string>"
    }
  }
}
Mutations

aiSaveEngineConfiguration

use profiles api
Description

Saves the configuration of the specified AI engine.

Response

Returns a Boolean!

Arguments
Name Description
profileId - ID!
settings - AIEngineConfig!

Example

Query
mutation aiSaveEngineConfiguration(
  $profileId: ID!,
  $settings: AIEngineConfig!
) {
  aiSaveEngineConfiguration(
    profileId: $profileId,
    settings: $settings
  )
}
Variables
{"profileId": "<id>", "settings": AIEngineConfig}
Response
{
  "data": {
    "aiSaveEngineConfiguration": "<boolean>"
  }
}
Mutations

aiSaveSettings

Description

Saves the global AI settings (active AI engine).

Response

Returns an AISettingsInfo!

Arguments
Name Description
settings - AISettingsConfig!

Example

Query
mutation aiSaveSettings($settings: AISettingsConfig!) {
  aiSaveSettings(settings: $settings) {
    activeEngine
    defaultConfiguration
    language
  }
}
Variables
{"settings": AISettingsConfig}
Response
{
  "data": {
    "aiSaveSettings": {
      "activeEngine": "<id>",
      "defaultConfiguration": "<id>",
      "language": "<string>"
    }
  }
}
Mutations

aiSaveToolboxSettings

Description
Available in Enterprise, AWS and GCP editions only.

Saves MCP server configuration and tool enablement.

Response

Returns an AIToolboxInfo!

Arguments
Name Description
server - AIToolboxSettingsInput!

Example

Query
mutation aiSaveToolboxSettings($server: AIToolboxSettingsInput!) {
  aiSaveToolboxSettings(server: $server) {
    id
    name
    description
    internal
    enabled
    configuration
    status
    statusMessage
    tools {
      ...AIToolInfoFragment
    }
  }
}
Variables
{"server": AIToolboxSettingsInput}
Response
{
  "data": {
    "aiSaveToolboxSettings": {
      "id": "<id>",
      "name": "<string>",
      "description": "<string>",
      "internal": "<boolean>",
      "enabled": "<boolean>",
      "configuration": "<object>",
      "status": "AVAILABLE",
      "statusMessage": "<string>",
      "tools": [AIToolInfo]
    }
  }
}
Mutations

aiSendChatMessage

Description

Sends a chat message to the AI chat conversation and returns a message ID from response. The response will be received partially via websockets.

Response

Returns an AISendChatMessageInfo!

Arguments
Name Description
conversationId - ID!
prompt - String!

Example

Query
mutation aiSendChatMessage(
  $conversationId: ID!,
  $prompt: String!
) {
  aiSendChatMessage(
    conversationId: $conversationId,
    prompt: $prompt
  ) {
    conversation {
      ...AIChatConversationInfoFragment
    }
    userMessage {
      ...AIMessageFragment
    }
    assistantMessage {
      ...AIMessageFragment
    }
  }
}
Variables
{"conversationId": "<id>", "prompt": "<string>"}
Response
{
  "data": {
    "aiSendChatMessage": {
      "conversation": AIChatConversationInfo,
      "userMessage": AIMessage,
      "assistantMessage": AIMessage
    }
  }
}
Mutations

aiSendSystemChatMessage

Description
Available in Enterprise, AWS and GCP editions only.

Sends a system chat message related to a message type to the AI chat conversation and returns a message ID from response. The response will be received partially via websockets. Unlike aiSendChatMessage, this method is used to send system messages that are not user-generated. The type parameter specifies the type of the system message, such as "ERROR" or "DESCRIBE". The parameters parameter is an object that contains additional parameters for the system message. Examples:

  • if the type is "DESCRIBE", the parameters must include an the node path of the object to describe (nodePath parameter).
  • if the type is "ERROR", the parameters must include the error message (errorMessage parameter) and SQL query (query parameter) that was not executed successfully.
  • if the type is "EXPLAIN_QUERY", must include the SQL query (query parameter)
  • if the type is "EXPLAIN_EXECUTION_PLAN", it must include the:
  • SQL query (query parameter)
  • Optional: execution plan configuration (executionPlanConfiguration parameter)
Response

Returns an AISendChatMessageInfo!

Arguments
Name Description
conversationId - ID!
type - String!
parameters - Object

Example

Query
mutation aiSendSystemChatMessage(
  $conversationId: ID!,
  $type: String!,
  $parameters: Object
) {
  aiSendSystemChatMessage(
    conversationId: $conversationId,
    type: $type,
    parameters: $parameters
  ) {
    conversation {
      ...AIChatConversationInfoFragment
    }
    userMessage {
      ...AIMessageFragment
    }
    assistantMessage {
      ...AIMessageFragment
    }
  }
}
Variables
{"conversationId": "<id>", "type": "<string>", "parameters": "<object>"}
Response
{
  "data": {
    "aiSendSystemChatMessage": {
      "conversation": AIChatConversationInfo,
      "userMessage": AIMessage,
      "assistantMessage": AIMessage
    }
  }
}
Mutations

aiSetFunctionsEnabled

Description
Available in Enterprise, AWS and GCP editions only.

Enables or disables all AI tools globally.

Response

Returns an AIToolsSettingsInfo!

Arguments
Name Description
enabled - Boolean!

Example

Query
mutation aiSetFunctionsEnabled($enabled: Boolean!) {
  aiSetFunctionsEnabled(enabled: $enabled) {
    servers {
      ...AIToolboxInfoFragment
    }
    functionsEnabled
  }
}
Variables
{"enabled": "<boolean>"}
Response
{
  "data": {
    "aiSetFunctionsEnabled": {
      "servers": [AIToolboxInfo],
      "functionsEnabled": "<boolean>"
    }
  }
}
Mutations

aiUpdateChatConversation

Description

Updates the caption of the AI chat conversation

Response

Returns an AIChatConversationInfo!

Arguments
Name Description
conversationId - ID!
config - AIChatConversationInput!

Example

Query
mutation aiUpdateChatConversation(
  $conversationId: ID!,
  $config: AIChatConversationInput!
) {
  aiUpdateChatConversation(
    conversationId: $conversationId,
    config: $config
  ) {
    dataSourceId {
      ...DataSourceIdFragment
    }
    id
    promptGeneratorId
    caption
    time
    messages {
      ...AIMessageFragment
    }
    settings {
      ...AIChatConversationSettingsFragment
    }
    waitingForResponse
    metrics {
      ...AIChatConversationMetricsFragment
    }
    profile
  }
}
Variables
{
  "conversationId": "<id>",
  "config": AIChatConversationInput
}
Response
{
  "data": {
    "aiUpdateChatConversation": {
      "dataSourceId": DataSourceId,
      "id": "<id>",
      "promptGeneratorId": "<id>",
      "caption": "<string>",
      "time": "<datetime>",
      "messages": [AIMessage],
      "settings": AIChatConversationSettings,
      "waitingForResponse": "<boolean>",
      "metrics": AIChatConversationMetrics,
      "profile": "<id>"
    }
  }
}
Mutations

aiUpdateProfile

Description

Updates the configuration of the specified AI engine configuration profile.

Response

Returns an AIAdminConfigurationProfileInfo!

Arguments
Name Description
config - AIConfigurationProfileInput!

Example

Query
mutation aiUpdateProfile($config: AIConfigurationProfileInput!) {
  aiUpdateProfile(config: $config) {
    id
    name
    engineId
    configuration {
      ...ObjectPropertyInfoFragment
    }
  }
}
Variables
{"config": AIConfigurationProfileInput}
Response
{
  "data": {
    "aiUpdateProfile": {
      "id": "<id>",
      "name": "<string>",
      "engineId": "<id>",
      "configuration": [ObjectPropertyInfo]
    }
  }
}
Mutations

asyncAiPerformQueryCompletion

Description

Creates an anync task to perform AI query completion.

Response

Returns an AsyncTaskInfo!

Arguments
Name Description
projectId - ID
connectionId - ID!
contextId - ID!
request - String!

Example

Query
mutation asyncAiPerformQueryCompletion(
  $projectId: ID,
  $connectionId: ID!,
  $contextId: ID!,
  $request: String!
) {
  asyncAiPerformQueryCompletion(
    projectId: $projectId,
    connectionId: $connectionId,
    contextId: $contextId,
    request: $request
  ) {
    id
    name
    running
    status
    error {
      ...ServerErrorFragment
    }
    taskResult
  }
}
Variables
{
  "projectId": "<id>",
  "connectionId": "<id>",
  "contextId": "<id>",
  "request": "<string>"
}
Response
{
  "data": {
    "asyncAiPerformQueryCompletion": {
      "id": "<string>",
      "name": "<string>",
      "running": "<boolean>",
      "status": "<string>",
      "error": ServerError,
      "taskResult": "<object>"
    }
  }
}
Mutations

asyncAiPerformQueryCompletionResult

Description

Retrieves the result of an async AI query completion task.

Response

Returns a String

Arguments
Name Description
taskId - ID!

Example

Query
mutation asyncAiPerformQueryCompletionResult($taskId: ID!) {
  asyncAiPerformQueryCompletionResult(taskId: $taskId)
}
Variables
{"taskId": "<id>"}
Response
{
  "data": {
    "asyncAiPerformQueryCompletionResult": "<string>"
  }
}

Types

AIAdminConfigurationProfileInfo

Fields
Field Name Description
id - ID! Unique identifier of the AI engine profile.
name - String! Name of the AI engine profile.
engineId - ID! ID of the AI engine that this profile belongs to.
configuration - [ObjectPropertyInfo!]! Configuration of the AI engine profile.
Example
{
  "id": "<id>",
  "name": "<string>",
  "engineId": "<id>",
  "configuration": [ObjectPropertyInfo]
}
Types

AIChatConversationInfo

Fields
Field Name Description
dataSourceId - DataSourceId
id - ID!
promptGeneratorId - ID
caption - String!
time - DateTime! Last message creation time.
messages - [AIMessage!]!
settings - AIChatConversationSettings
waitingForResponse - Boolean!
metrics - AIChatConversationMetrics
profile - ID ID of the AI engine configuration profile used for this conversation.
Example
{
  "dataSourceId": DataSourceId,
  "id": "<id>",
  "promptGeneratorId": "<id>",
  "caption": "<string>",
  "time": "<datetime>",
  "messages": [AIMessage],
  "settings": AIChatConversationSettings,
  "waitingForResponse": "<boolean>",
  "metrics": AIChatConversationMetrics,
  "profile": "<id>"
}
Types

AIChatConversationInput

Fields
Input Field Description
dataSourceId - DataSourceIdInput
caption - String
settings - AIChatConversationSettingsInput
promptGeneratorId - ID ID of the prompt generator to use for this conversation (sql - by default).
Example
{
  "dataSourceId": DataSourceIdInput,
  "caption": "<string>",
  "settings": AIChatConversationSettingsInput,
  "promptGeneratorId": "<id>"
}
Types

AIChatConversationMetrics

Fields
Field Name Description
totalInputTokens - Int!
totalOutputTokens - Int!
Example
{"totalInputTokens": "<int>", "totalOutputTokens": "<int>"}
Types

AIChatConversationSettings

Fields
Field Name Description
metaTransferConfirmed - Boolean!
scope - AIDatabaseScope
customObjectIds - [ID!] If the scope is set to CUSTOM, this field is required.
Example
{
  "metaTransferConfirmed": "<boolean>",
  "scope": "CURRENT_SCHEMA",
  "customObjectIds": ["<id>"]
}
Types

AIChatConversationSettingsInput

Fields
Input Field Description
metaTransferConfirmed - Boolean
scope - AIDatabaseScope
profile - ID
customObjectIds - [ID!]
Example
{
  "metaTransferConfirmed": "<boolean>",
  "scope": "CURRENT_SCHEMA",
  "profile": "<id>",
  "customObjectIds": ["<id>"]
}
Types

AIConfigurationProfileInfo

Fields
Field Name Description
id - ID! Unique identifier of the AI engine profile.
name - String! Name of the AI engine profile.
engineId - ID! ID of the AI engine that this profile belongs to.
Example
{"id": "<id>", "name": "<string>", "engineId": "<id>"}
Types

AIConfigurationProfileInput

Fields
Input Field Description
profileId - ID! Unique identifier of the AI engine profile.
profileName - String Name of the AI engine profile.
engineId - ID ID of the AI engine that this profile belongs to.
configuration - AIEngineConfig Configuration of the AI engine profile.
Example
{
  "profileId": "<id>",
  "profileName": "<string>",
  "engineId": "<id>",
  "configuration": AIEngineConfig
}
Types

AIDataSourceSettingsInfo

Fields
Field Name Description
metaTransferConfirmed - Boolean! Indicates whether user confirmed meta transfer to AI for the current data source.
scope - AIDatabaseScope Default scope for AI operations in this data source.
customObjectIds - [ID!] If the scope is set to CUSTOM, this field is required.
mcpEnabled - Boolean! Indicates whether MCP integration is enabled for the current data source.
mcpEndpoint - String MCP endpoint URL for the current data source.
Example
{
  "metaTransferConfirmed": "<boolean>",
  "scope": "CURRENT_SCHEMA",
  "customObjectIds": ["<id>"],
  "mcpEnabled": "<boolean>",
  "mcpEndpoint": "<string>"
}
Types

AIDataSourceSettingsInput

Fields
Input Field Description
mcpEnabled - Boolean Flag indicating whether MCP integration is enabled for the current data source.
metaTransferConfirmed - Boolean Flag indicating whether user confirmed meta transfer to AI.
scope - AIDatabaseScope Default scope for AI operations in this data source.
customObjectIds - [ID!] If custom scope is selected, this field is required.
Example
{
  "mcpEnabled": "<boolean>",
  "metaTransferConfirmed": "<boolean>",
  "scope": "CURRENT_SCHEMA",
  "customObjectIds": ["<id>"]
}
Types

AIDatabaseScope

Description

Scope of the AI chat conversation. Can be a database connection, a current database, a current schema or a custom scope.

Values
Enum Value Description

CURRENT_SCHEMA

CURRENT_DATABASE

CURRENT_DATASOURCE

CUSTOM
Example
"CURRENT_SCHEMA"
Types

AIEngineConfig

Fields
Input Field Description
properties - Object
Example
{"properties": "<object>"}
Types

AIEngineInfo

Fields
Field Name Description
id - ID! Unique identifier of the AI engine.
name - String! Name of the AI engine.
Example
{"id": "<id>", "name": "<string>"}
Types

AIFunction

Fields
Field Name Description
id - ID! Unique identifier of the function (combines toolbox ID and function ID)
name - String! Human-readable name of the function
description - String Detailed description of what the function does
icon - String URL or path to the function icon
system - Boolean! Indicates whether the function is a system function (can be auto-confirmed when required)
Example
{
  "id": "<id>",
  "name": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "system": "<boolean>"
}
Types

AIFunctionCall

Fields
Field Name Description
id - ID!
functionName - String!
arguments - Object
hint - String
Example
{
  "id": "<id>",
  "functionName": "<string>",
  "arguments": "<object>",
  "hint": "<string>"
}
Types

AIFunctionConfirmation

Fields
Field Name Description
functionCalls - [AIFunctionCall!]!
Example
{"functionCalls": [AIFunctionCall]}
Types

AIFunctionResult

Fields
Field Name Description
type - AIFunctionType!
value - Object!
Example
{"type": "ACTION", "value": "<object>"}
Types

AIFunctionType

Values
Enum Value Description

ACTION

INFORMATION
Example
"ACTION"
Types

AIMessage

Fields
Field Name Description
conversationId - ID!
id - ID!
role - AIMessageType!
content - String!
displayMessage - String!
time - DateTime!
functionConfirmation - AIFunctionConfirmation Present only with CONFIRMATION role
functionCall - AIFunctionCall Present only with FUNCTION role
functionResult - AIFunctionResult Present only with FUNCTION role
Example
{
  "conversationId": "<id>",
  "id": "<id>",
  "role": "SYSTEM",
  "content": "<string>",
  "displayMessage": "<string>",
  "time": "<datetime>",
  "functionConfirmation": AIFunctionConfirmation,
  "functionCall": AIFunctionCall,
  "functionResult": AIFunctionResult
}
Types

AIMessageType

Values
Enum Value Description

SYSTEM

USER

ASSISTANT

ERROR

WARNING

CONFIRMATION

ATTACHMENT

FUNCTION
Example
"SYSTEM"
Types

AISendChatMessageInfo

Fields
Field Name Description
conversation - AIChatConversationInfo!
userMessage - AIMessage!
assistantMessage - AIMessage! Message that would be received via websockets.
Example
{
  "conversation": AIChatConversationInfo,
  "userMessage": AIMessage,
  "assistantMessage": AIMessage
}
Types

AISettingsConfig

Fields
Input Field Description
defaultConfiguration - ID Default configuration profile ID. May be null if AI wasn't configured
language - String Language to be used as a default for AI responses
Example
{"defaultConfiguration": "<id>", "language": "<string>"}
Types

AISettingsInfo

Fields
Field Name Description
activeEngine - ID!
defaultConfiguration - ID
language - String
Example
{"activeEngine": "<id>", "defaultConfiguration": "<id>", "language": "<string>"}
Types

AIToolInfo

Description
Available in Enterprise, AWS and GCP editions only.
Fields
Field Name Description
id - ID!
name - String!
type - AIFunctionType!
description - String
categoryId - ID
categoryName - String
enabled - Boolean!
enabledByDefault - Boolean!
Example
{
  "id": "<id>",
  "name": "<string>",
  "type": "ACTION",
  "description": "<string>",
  "categoryId": "<id>",
  "categoryName": "<string>",
  "enabled": "<boolean>",
  "enabledByDefault": "<boolean>"
}
Types

AIToolSettingsInput

Description
Available in Enterprise, AWS and GCP editions only.
Fields
Input Field Description
id - ID!
enabled - Boolean
Example
{"id": "<id>", "enabled": "<boolean>"}
Types

AIToolboxInfo

Description
Available in Enterprise, AWS and GCP editions only.
Fields
Field Name Description
id - ID!
name - String!
description - String
internal - Boolean!
enabled - Boolean!
configuration - Object
status - AIToolboxStatus!
statusMessage - String
tools - [AIToolInfo!]!
Example
{
  "id": "<id>",
  "name": "<string>",
  "description": "<string>",
  "internal": "<boolean>",
  "enabled": "<boolean>",
  "configuration": "<object>",
  "status": "AVAILABLE",
  "statusMessage": "<string>",
  "tools": [AIToolInfo]
}
Types

AIToolboxSettingsInput

Description
Available in Enterprise, AWS and GCP editions only.
Fields
Input Field Description
id - ID!
enabled - Boolean
configuration - Object MCP server configuration. Internal toolbox ignores this field.
tools - [AIToolSettingsInput!]
Example
{
  "id": "<id>",
  "enabled": "<boolean>",
  "configuration": "<object>",
  "tools": [AIToolSettingsInput]
}
Types

AIToolboxStatus

Description
Available in Enterprise, AWS and GCP editions only.
Values
Enum Value Description

AVAILABLE

DISABLED

ERROR
Example
"AVAILABLE"
Types

AIToolsSettingsInfo

Description
Available in Enterprise, AWS and GCP editions only.
Fields
Field Name Description
servers - [AIToolboxInfo!]!
functionsEnabled - Boolean!
Example
{
  "servers": [AIToolboxInfo],
  "functionsEnabled": "<boolean>"
}
Types

AsyncTaskInfo

Description

Async types

Fields
Field Name Description
id - String! Task unique identifier
name - String Async task name
running - Boolean! Indicates if the task is currently running
status - String Current status of the async task
error - ServerError Error information if the task failed
taskResult - Object Task result. Can be some kind of identifier to obtain real result using another API function
Example
{
  "id": "<string>",
  "name": "<string>",
  "running": "<boolean>",
  "status": "<string>",
  "error": ServerError,
  "taskResult": "<object>"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

Condition

Description

Represents a dynamic condition for a property, such as visibility or read-only state

Fields
Field Name Description
expression - String! The logical expression that defines when the condition applies
conditionType - ConditionType! The type of condition (e.g., HIDE or READ_ONLY)
Example
{"expression": "<string>", "conditionType": "HIDE"}
Types

ConditionType

Values
Enum Value Description

HIDE

 hiding property condition

READ_ONLY

 restriction for setting a property value
Example
"HIDE"
Types

DataSourceId

Fields
Field Name Description
projectId - ID!
connectionId - ID!
Example
{"projectId": "<id>", "connectionId": "<id>"}
Types

DataSourceIdInput

Fields
Input Field Description
projectId - ID!
connectionId - ID!
Example
{"projectId": "<id>", "connectionId": "<id>"}
Types

DateTime

Description

Date/Time

Example
"<datetime>"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"<id>"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
"<int>"
Types

Object

Description

Any object (JSON)

Example
"<object>"
Types

ObjectPropertyInfo

Description

Information about the object property used to generate its UI

Fields
Field Name Description
id - String Unique property identifier
displayName - String Human-readable name
description - String Property description
hint - String Usage hint for the property
category - String Property category (may be used if object has a lot of properties)
dataType - String Property data type (e.g., int, String)
value - Object Property value (can be resource-intensive for some properties, e.g., RowCount for tables)
validValues - [Object] List of allowed values (for enumerable properties)
defaultValue - Object Default property value
length - ObjectPropertyLength! Property value length
features - [String!]! List of supported features (e.g., system, hidden, inherited, foreign, expensive)
order - Int! Order position
supportedConfigurationTypes - [String!] Supported configuration types (for driver properties)
required - Boolean! Is the property required
scopes - [String!] List of preference scopes (e.g., global, user)
conditions - [Condition!] Dynamic conditions for the property (e.g., visibility or read-only)
Example
{
  "id": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "hint": "<string>",
  "category": "<string>",
  "dataType": "<string>",
  "value": "<object>",
  "validValues": ["<object>"],
  "defaultValue": "<object>",
  "length": "TINY",
  "features": ["<string>"],
  "order": "<int>",
  "supportedConfigurationTypes": ["<string>"],
  "required": "<boolean>",
  "scopes": ["<string>"],
  "conditions": [Condition]
}
Types

ObjectPropertyLength

Values
Enum Value Description

TINY

 1 character

SHORT

 20 characters

MEDIUM

 <= 64 characters

LONG

 Full line length. The default

MULTILINE

 Multi-line long text
Example
"TINY"
Types

ServerError

Description

Various server errors descriptor

Fields
Field Name Description
message - String Error message text
errorCode - String Retrieves the vendor-specific error code
errorType - String Type/category of the error
stackTrace - String Stack trace for debugging
causedBy - ServerError Nested error that caused this error (recursive)
Example
{
  "message": "<string>",
  "errorCode": "<string>",
  "errorType": "<string>",
  "stackTrace": "<string>",
  "causedBy": ServerError
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"<string>"
Documentation by Anvil SpectaQL