MatrixOrigin MatrixOrigin Docs
MatrixOne Intelligence MatrixOne
Get Started Guides Developer Reference Release Notes Tutorials
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
MatrixOne Intelligence Docs
MatrixOne Intelligence Docs

Reference

  • Reference
    • SQL reference
      • Structure and Syntax
        • Keywords
        • Comments
      • Data Types
        • Data Types Overview
        • Data Type Conversion
        • Date and Time Types
          • TIMESTAMP and DATETIME Auto-Initialization and Update
          • YEAR Type
        • JSON Data Type
        • BLOB and TEXT Data Types
        • DATALINK Data Type
        • ENUM Type
        • UUID Data Type
        • Fixed-Point Numeric Types (DECIMAL)
        • Vector Data Type
      • SQL Statements
        • SQL Statement Categories
        • Data Definition Language (DDL)
          • CREATE DATABASE
          • CREATE INDEX
          • CREATE INDEX...USING IVFFLAT
          • CREATE TABLE
          • CREATE TABLE AS SELECT
          • CREATE EXTERNAL TABLE
          • CREATE PITR
          • CREATE PUBLICATION
          • CREATE SEQUENCE
          • CREATE STAGE
          • CREATE...FROM...PUBLICATION...
          • CREATE VIEW
          • CREATE FUNCTION...LANGUAGE SQL AS
          • CREATE SOURCE
          • CREATE DYNAMIC TABLE
          • CREATE SNAPSHOT
          • ALTER TABLE
          • ALTER TABLE ... ALTER REINDEX
          • ALTER PITR
          • ALTER PUBLICATION
          • ALTER SEQUENCE
          • ALTER STAGE
          • ALTER VIEW
          • DROP DATABASE
          • DROP INDEX
          • DROP TABLE
          • DROP PITR
          • DROP PUBLICATION
          • DROP SEQUENCE
          • DROP STAGE
          • DROP SNAPSHOT
          • DROP VIEW
          • DROP FUNCTION
          • TRUNCATE TABLE
          • RENAME TABLE
          • RESTORE PITR
          • RESTORE ACCOUNT
          • RESTORE SNAPSHOT
        • Data Manipulation Language (DML)
          • INSERT
          • INSERT INTO SELECT
          • DELETE
          • UPDATE
          • LOAD DATA INFILE
          • LOAD DATA INLINE
          • UPSERT
            • UPSERT Overview
            • INSERT ON DUPLICATE KEY UPDATE
            • INSERT IGNORE
            • REPLACE
          • Information Functions
            • LAST_QUERY_ID()
            • LAST_INSERT_ID()
        • Data Query Language (DQL)
          • SELECT
          • SUBQUERY
            • SUBQUERY Overview
            • Derived Tables
            • Subqueries with Comparison Operators
            • SUBQUERY with ANY or SOME
            • SUBQUERY with ALL
            • SUBQUERY with EXISTS
            • SUBQUERY with IN
          • JOIN
            • JOIN Overview
            • INNER JOIN
            • LEFT JOIN
            • RIGHT JOIN
            • FULL JOIN
            • OUTER JOIN
            • NATURAL JOIN
          • With CTE
          • Union Queries
            • UNION
            • INTERSECT
            • MINUS
            • UNION / INTERSECT / MINUS Overview
        • Data Control Language (DCL)
          • CREATE ROLE
          • CREATE USER
          • ALTER USER
          • DROP USER
          • DROP ROLE
          • GRANT
          • REVOKE
        • Transactions (TCL)
          • START TRANSACTION / BEGIN
          • COMMIT
          • ROLLBACK
          • SET AUTOCOMMIT
        • Others
          • SHOW
            • SHOW ACCOUNTS
            • SHOW DATABASES
            • SHOW CREATE TABLE
            • SHOW CREATE VIEW
            • SHOW CREATE PUBLICATION
            • SHOW TABLES
            • SHOW INDEX
            • SHOW COLLATION
            • SHOW COLUMNS
            • SHOW FUNCTION STATUS
            • SHOW GRANTS
            • SHOW PROCESSLIST
            • SHOW PUBLICATIONS
            • SHOW PITR
            • SHOW ROLES
            • SHOW SEQUENCES
            • SHOW SNAPSHOTS
            • SHOW STAGES
            • SHOW SUBSCRIPTIONS
            • SHOW VARIABLES
          • SET
            • SET ROLE
          • USE
            • USE DATABASE
          • KILL
          • Prepared
            • PREPARE
            • EXECUTE
            • DEALLOCATE
          • Explain
            • Explain
            • EXPLAIN output format
            • Explain Analyze
      • Functions
        • Function List
        • Aggregate Functions
          • ANY_VALUE
          • AVG
          • BITMAP
          • BIT_AND
          • BIT_OR
          • BIT_XOR
          • COUNT
          • GROUP_CONCAT
          • MAX
          • MEDIAN
          • MIN
          • STDDEV_POP
          • SUM
          • VARIANCE
          • VAR_POP
        • Date and Time Functions
          • CONVERT_TZ()
          • CURDATE()
          • CURRENT_TIMESTAMP()
          • DATE()
          • DATE_ADD()
          • DATE_FORMAT()
          • DATE_SUB()
          • DATEDIFF()
          • DAY()
          • DAYOFYEAR()
          • EXTRACT()
          • HOUR()
          • FROM_UNIXTIME
          • MINUTE()
          • MONTH()
          • NOW()
          • SECOND()
          • STR_TO_DATE()
          • SYSDATE()
          • TIME()
          • TIMEDIFF()
          • TIMESTAMP()
          • TIMESTAMPDIFF()
          • TO_DATE()
          • TO_DAYS()
          • TO_SECONDS()
          • UNIX_TIMESTAMP
          • UTC_TIMESTAMP()
          • WEEK()
          • WEEKDAY()
          • YEAR()
        • Mathematical Functions
          • ABS()
          • ACOS()
          • ATAN()
          • CEIL()
          • CEILING()
          • COS()
          • COT()
          • EXP()
          • FLOOR()
          • LN()
          • LOG()
          • LOG2()
          • LOG10()
          • PI()
          • POWER()
          • ROUND()
          • RAND()
          • SIN()
          • SINH()
          • TAN()
        • String Functions
          • BIN()
          • BIT_LENGTH()
          • CHAR_LENGTH()
          • CONCAT()
          • CONCAT_WS()
          • EMPTY()
          • ENDSWITH()
          • FIELD()
          • FIND_IN_SET()
          • FORMAT()
          • FROM_BASE64()
          • HEX()
          • INSTR()
          • LCASE()
          • LEFT()
          • LENGTH()
          • LOCATE()
          • LOWER()
          • LPAD()
          • LTRIM()
          • MD5()
          • OCT()
          • REPEAT()
          • REVERSE()
          • RPAD()
          • RTRIM()
          • SHA1()/SHA()
          • SHA2()
          • SPACE()
          • SPLIT_PART()
          • STARTSWITH()
          • SUBSTRING()
          • SUBSTRING_INDEX()
          • TO_BASE64()
          • TRIM()
          • UCASE()
          • UNHEX()
          • UPPER()
          • Regular Expression Overview
            • Regular expression overview
            • NOT REGEXP
            • REGEXP_INSTR()
            • REGEXP_LIKE()
            • REGEXP_REPLACE()
            • REGEXP_SUBSTR()
        • Vector Functions
          • Basic Operators
          • Mathematical Calculations
          • CLUSTER_CENTERS()
          • COSINE_SIMILARITY()
          • COSINE_DISTANCE()
          • INNER_PRODUCT()
          • L1_NORM()
          • L2_NORM()
          • L2_DISTANCE()
          • NORMALIZE_L2()
          • SUBVECTOR()
          • VECTOR_DIMS()
        • Table Functions
          • GENERATE_SERIES()
          • UNNEST()
        • Window Functions
          • DENSE_RANK()
          • RANK()
          • ROW_NUMBER()
        • JSON Functions
          • JQ()
          • JSON_EXTRACT()
          • JSON_EXTRACT_FLOAT64()
          • JSON_EXTRACT_STRING()
          • JSON_QUOTE()
          • JSON_ROW()
          • JSON_UNQUOTE()
          • TRY_JQ()
        • Other Functions
          • LOAD_FILE
          • SAVE_FILE
          • SAMPLE
          • SERIAL_EXTRACT
          • SLEEP
          • STAGE_LIST
          • UUID()
        • System Operations Functions
          • CURRENT_ROLE_NAME()
          • CURRENT_ROLE()
          • CURRENT_USER_NAME()
          • CURRENT_USER()
          • VERSION()
          • PURGE_LOG()
      • Operators
        • INTERVAL
        • Operators Overview
        • Operator Precedence
        • Arithmetic Operators
          • Arithmetic Operators Overview
          • %,MOD
          • *
          • +
          • - (subtraction)
          • - (unary minus)
          • /
          • DIV
        • Assignment Operators
          • Assignment Operators Overview
          • =
        • Bitwise Operators
          • Bitwise Operators Overview
          • &
          • >>
          • <<
          • ^
          • |
          • ~
        • Cast Functions and Operators
          • Cast Functions and Operators Overview
          • BINARY
          • CAST
          • CONVERT
          • DECODE
          • ENCODE
          • SERIAL
          • SERIAL_FULL
        • Comparison Functions and Operators
          • Comparison Functions and Operators Overview
          • >
          • >=
          • <
          • <>,!=
          • <=
          • =
          • BETWEEN ... AND ...
          • IN
          • IS
          • IS NOT
          • IS NOT NULL
          • IS NULL
          • ISNULL
          • ILIKE
          • LIKE
          • NOT BETWEEN ... AND ...
          • NOT IN
          • NOT LIKE
          • COALESCE
        • Control Flow Functions
          • Control Flow Functions Overview
          • CASE WHEN
          • IF
          • IFNULL
          • NULLIF
        • Logical Operators
          • Logical Operators Overview
          • AND,&&
          • NOT,!
          • OR
          • XOR
      • System Variables
        • System Variables Overview
        • System Variable Parameters
          • SQL Mode
          • Query Result Saving Support
          • Timezone Support
          • Case Sensitivity Support
          • Foreign Key Check Support
          • Query Result Column Name Consistency
          • Illegal Login Restrictions
          • Password Complexity Check
          • Connection Whitelist
        • Custom Variables
      • System Tables
      • Privilege Categories
      • Limitations
        • MatrixOne JDBC Feature Support List
        • MatrixOne DDL Statement Partition Support
        • MatrixOne Load Data Support
    • API reference
      • Prepare to call an API
        • Browser login sessions
          • Browser login and callback protocol
          • Browser logout and callback protocol
          • Get the current browser session
          • Cookies, languages, and deployment boundaries
        • System configuration
          • Get database connection information for the current workspace
          • Get account-level chat model policy
          • Bootstrap product identity for a native CLI
          • Get product process version information
      • Genesis
        • Model inference
          • List callable models
          • Chat generation (Chat Completions)
            • Create a Chat Completion
          • Message generation (Messages)
            • Create a Message
            • Count input tokens
          • Response generation and management (Responses)
            • Create a Response
            • Retrieve a Response
            • List Response input items
            • Delete a Response
          • Conversation management
            • Create a conversation
            • Retrieve a conversation
            • Update conversation metadata
            • Delete a conversation
            • Create a conversation item
            • List conversation items
            • Retrieve a conversation item
            • Delete a conversation item
          • Embeddings
            • Create an Embedding
          • Audio transcription
          • Document reranking
            • Rerank documents
        • Usage and monitoring
          • Model catalog
            • List the model catalog
            • List the public model catalog
            • List model selection options
            • Get model filter options
            • Get model health
            • Get public model overview
          • Call usage
            • Get usage summary
            • Get usage trends
            • Get grouped usage
          • Request logs
            • List request logs
            • Get request log details
            • List upstream request attempts
            • Download a request or response body
          • Local token keys
            • Get local key issuance capability
            • List local token keys
          • Notifications
            • List notifications
            • Get unread notification counts
            • List notification channels
            • List notification rules
          • Runtime status
            • Get model runtime status
        • Accounts and billing
          • Accounts
            • List current accounts
            • Get account overview
            • Get billing settings
          • Usage and costs
            • Get rated usage summary
            • List rated usage records
            • Get cost trends
            • List AI service usage
          • Transactions
            • List transactions
            • List consumption aggregates
          • Bills
            • List monthly bills
            • List monthly bill usage line items
          • Recharges
            • Get recharge options
            • List recharge orders
          • Payment authorizations
            • List payment authorizations
          • Subscriptions
            • List subscription products
            • List subscriptions
        • Feedback tickets
          • Submit a feedback ticket
          • List my feedback tickets
          • Feedback ticket objects
      • AI Studio
        • Workspaces
          • List workspaces
          • Submit a workspace-creation task
          • List workspace-creation tasks
          • Create a workspace
          • Claim a workspace
          • Update a workspace
          • Accept a workspace invitation
          • Delete a workspace
        • Data Connections
          • Connectors
            • List connectors
            • Get connector details
            • Create a connector
            • Update a connector
            • Delete a connector
            • Validate connector configuration
          • Connector files
            • List files
            • Upload files
            • Preview a file
            • Download a file
            • Delete a file
          • Browse databases
            • View browsable connectors
            • List databases
            • List database schemas
            • List tables
            • Get table schema
          • Import tasks
            • List tasks
            • Get task details
            • Import task object fields
            • Create a task
            • Upload locally and create an import task
            • Create a database structured-load task
            • Resolve a structured-load backfill start
            • Update a task
            • Delete a task
            • Pause a task
            • Resume a task
            • List task files
            • List run records
            • Get import task statistics
            • Retry failed files
          • Export tasks
            • List tasks
            • Get task details
            • Create a task
            • Delete a task
            • List export files
            • Get task status
            • Rerun a task
            • Configure an export target
            • Check an export target table name
            • Generate export target column mappings
          • Connector callback protocols
            • Credential callback protocol
            • List connector database names
            • Read connector table columns
            • List schema names in a connector database
            • List connector table names
            • Message connection callback protocol
            • List MatrixOne destination database names
            • List MatrixOne destination table names
            • Connector requests and results
            • Two connector metadata protocols
          • REST data sources
            • Shared information for REST API sources
            • Preview a REST API source sample
            • Probe an unsaved REST API configuration
            • Probe a saved REST API connector
          • Structured data sources
            • Get structured-source read capabilities
            • Shared information for structured sources and import control
            • Trigger a full refresh for periodic incremental import
            • Trigger a periodic structured import immediately
            • Read Kafka source samples
        • Data processing
          • Workflows
            • Create workflow
            • List workflows
            • Get workflow details
            • Update workflow
            • Pause workflow
            • Resume workflow
            • Delete workflow
            • Workflow proposals
              • Prepare task test resources
              • List workflow candidate history
              • Workflow candidates and test resources
              • Observe task test resource samples
              • Reject a pending workflow proposal
              • Reset test resources for a running task
              • Restore a historical workflow candidate as a new proposal
              • Submit a task project candidate
              • Test a task workflow project
            • Workflow tasks
              • Create a Worker task using an explicit workflow version
              • Identifier handoff and result confirmation
          • Workflow templates
            • View workflow template list
            • View workflow template details
            • Create workflow template
            • Update workflow template
            • Delete workflow template
          • Workflow jobs
            • Start workflow job
            • View workflow jobs
            • View workflow job details
            • Refresh workflow job status
            • View workflow job results
            • View workflow job node
            • Pause workflow job
            • Resume workflow job
            • Cancel workflow job
            • Delete workflow job
            • View file execution records
          • Workflow reruns
            • View node rerun plan
            • Rerun from a specified node
            • View workflow reruns
            • View workflow rerun details
            • Cancel workflow rerun
          • Workflow retries
            • Retry workflow job
            • Batch retry workflow jobs
          • Custom operators
            • View custom operator list
            • View custom operator details
            • View custom operator code
            • Create custom operator
            • Update custom operator
            • Test-run custom operator
            • Enable custom operator
            • Disable custom operator
            • Manage custom operator MCP
            • Delete custom operator
            • Read custom operator source by node identity
          • Workflow operator catalog
            • View workflow operator list
            • View workflow operator details
          • Operator API services
            • View operator API service configuration
            • Publish operator API service
            • Invoke operator API service
            • Enable operator API service
            • Disable operator API service
          • Data lineage
            • View file processing lineage
            • View processing result lineage
            • View processing node details
            • View processing result output contents
            • View processing result output version list
            • Create processing result output version
            • Set processing result effective version
            • View node output contents
            • View node output version list
            • Create node output version
            • Set node effective version
            • Rerun processing node
            • Rerun processing node with specified output version
          • SQL execution
            • Execute SQL
            • View execution status
            • Cancel execution
            • View execution result
            • Download execution result
            • Read the database, table, and view tree
            • Query results, identifiers, and errors
            • Run SQL once and return results
          • SQL metadata
            • View database list
            • View tables and views in a database
            • View table information
            • View table column list
            • View table or view creation statement
            • Delete database
            • Delete table
            • Delete view
          • SQL workbooks
            • View SQL workbook list
            • View SQL workbook version content
            • Create SQL workbook
            • Update SQL workbook name
            • Delete SQL workbook
            • View SQL workbook version list
            • Create SQL draft version
            • Update SQL draft version
            • Finalize SQL version
          • Data dashboards
            • View data dashboard list
            • View data dashboard details
            • Create data dashboard
            • Update data dashboard
            • Delete data dashboard
            • Create dashboard chart
            • Update dashboard chart
            • Delete dashboard chart
            • Preview dashboard chart SQL
            • Generate dashboard chart SQL draft
            • Run dashboard chart
            • View dashboard chart result
            • Download dashboard chart result
            • Refresh all dashboard charts
            • Download current detail CSV
            • Preview details for a chart point
            • Result identifiers and download errors
            • Update the complete dashboard chart order
          • Resource tags
            • Create a workflow resource tag
            • Add a tag value
            • Delete a workflow resource tag
            • Delete an allowed tag value
            • List workflow resource tags
            • List tag values
            • Workflow resource tag objects and calling rules
            • Query workflow tag assignments
            • Group workflow counts by tag
            • Filter workflows by tags
            • Workflow resource tag SDK and CLI calls
            • Batch update workflow tag assignments
            • Update a workflow resource tag
            • Update an allowed tag value
        • Resource Center
          • Catalog
            • Browse resources
              • Browse catalogs, databases, volumes and tables
              • Query the Catalog system tree
              • Get displayable resource actions
              • Health and reference compatibility boundaries
              • Download table data as CSV
              • Get a data asset by asset ID
              • Data asset result objects
              • Search selectable dashboard tables
              • Get a database table overview
              • Get table column names
              • Get workspace table overviews
            • Manage Catalogs
              • List Catalogs
              • Get Catalog details
              • Create a Catalog
              • Update a Catalog
              • Delete a Catalog
              • List Catalog references
            • Databases
              • List databases
              • Get database details
              • Create a database
              • Update a database
              • Delete a database
              • List objects in a database
              • List database tables
              • Run NL2SQL
            • File storage
              • Query volume details
              • Create volume
              • Update volume
              • Delete volume
              • Query the full path of the volume
              • Query file list
              • Query file details
              • Create file
              • Delete files
              • Upload files
              • Preview file
              • Download file
              • Create folder
              • Update folder
              • Delete folder
              • Clear the folder
              • Trigger file workflow
              • Runtime artifacts, images, and other file protocols
              • Read a file through a temporary capability link
              • Delete an unreferenced workspace file
              • Download a raw workspace file
              • Get workspace file metadata
              • File associations, references, and temporary reads
              • List workspace file reference locations
              • Issue a temporary model file link
              • File reads and location objects
              • Preview workspace file content
              • Upload to a personal private Catalog volume
              • Upload a workspace file record
            • Tables
              • Get table information
              • Get a table overview
              • Get the full table path
              • Get table data
              • Preview table data
              • Create a table
              • Check whether a table exists
              • Truncate a table
              • Delete a table
              • Batch get table information
            • References
              • List Catalog references
              • Query table reference
              • List volume references
              • List folder references
              • Unlink a file
            • Processing results
              • Get a data asset
              • Batch get data assets
              • List file-processing artifacts
              • Batch resolve file artifacts
          • Knowledge bases
            • Knowledge-base management
              • Query the knowledge base list
              • Query knowledge base tags
              • Query knowledge base details
              • Create knowledge base
              • Create a data-side empty knowledge base
              • Create a knowledge base and add data sources
              • Update knowledge base
              • Delete knowledge base
              • Get workspace export task statistics
              • Import knowledge base definitions and semantic entries
              • List agents referencing a knowledge base
              • Knowledge base definitions, references, and export statistics
            • Data
              • Upload local files to a knowledge base
              • Upload local files before creating a knowledge base
              • List data
              • Preview data to add
              • Preview data before creating a knowledge base
              • Check whether data has been added
              • Add data
              • Backfill data records for a knowledge base
              • Update data settings
              • Delete data
            • Documents and segments
              • Get document details
              • Preview a source file
              • Preview a processed image
              • Create a segment
              • Update a segment
              • Enable or disable a segment
              • Delete a segment
              • Re-vectorize a data source
            • Processing tasks
              • List processing tasks
              • Reconcile processing task status
            • Semantic entries
              • List semantic entries
              • Create a semantic entry
              • Update a semantic entry
              • Delete a semantic entry
              • Import semantic entries
              • Export semantic entries
              • Validate semantic entries
            • Drawing knowledge bases
              • Orphaned resource cleanup semantics
              • Get drawing provenance and page mappings
              • Drawing search response objects
              • Drawing source objects and gaps
              • Clean orphaned Workspace files and deleted volumes
              • Search drawings
              • Drawing search input and modes
            • Data processing
              • Query data processing tasks
              • Coordinate data processing tasks
              • Source governance and processing results
          • Compute instances
            • Manage compute instances
              • Query the computing resource list
              • Query computing resource details
              • Create computing resource
              • Update computing resource
              • Check before deletion
              • Delete computing resource
              • Pause computing resources
              • Restore computing resources
              • Retry compute resource
              • Query Worker running status
              • Query the available Worker image
              • Take over ownership of historical computing resources
            • Manage compute instance specifications
              • Query specification list
              • Query specification management permission
              • Create spec
              • Updated specs
              • Enable or disable specification
          • Data publishing
            • Query release list
            • Query release summary
            • Query the source database table
            • Check release name
            • Query the workspace name
            • Batch parse workspace names
            • Create Publish
            • Update released
            • Delete post
          • Data subscription
            • Query subscription list
            • Accept Subscription
            • Unsubscribe
          • Runners
            • Get compute instance Python dependency observations
            • Register a custom Runner
            • Unregister a Runner
            • Get visible executor connection states
            • Get Runner details
            • Runner connectivity and observation lifecycle
            • List Runners
            • Runner and compute observation objects
            • Get Python dependency configuration limits
            • Refresh Runner connection credentials
            • Renew an Edge registration token
          • Sandboxes
            • Create a workspace sandbox
            • Create sandbox SSH session credentials
            • Delete a workspace sandbox
            • Get sandbox quotas and network capabilities
            • Get sandbox details
            • Get a short-lived sandbox terminal token
            • List Workspace sandboxes
            • Sandbox objects, networks, and result confirmation
            • Connect an interactive sandbox terminal
            • Update sandbox egress allowlists
            • Update workspace sandbox quota
        • Monitoring
          • Get task execution overview
          • List SQL execution records
          • Get SQL execution details
          • Get SQL execution profile
          • Get SQL history overview
          • List operation logs
          • Get operation log overview
        • Users and permissions
          • Users and tags
            • User management
              • List users
              • Create a user
              • Update user information
              • Update user status
              • Delete a user
              • Compact role context and capability objects
              • Read the current principal and IAM context
              • Get workspace member details
            • Roles and audit records
              • Get user-role bindings
              • Update user-role bindings
              • List user audit events
            • User tags
              • View user tag list
              • Create user tag
              • Update user tag
              • Delete user tag
          • Roles and permissions
            • Role management
              • View role list
              • Update a role
              • Update role lifecycle
              • View role deletion impact
              • Delete a role
              • Create a role
              • Get capabilities of the current caller
              • Shared role write requests and results
              • List role ownerships before deletion
              • List role members
              • Set the current user's default role
              • Transfer an object's owner role
            • Role permissions and impact
              • Get the role permission view
              • Get role ownership impact
              • List role audit events
            • Role inheritance
              • List role inheritance relationships
              • Get the role inheritance graph
              • Add role inheritance
              • Remove role inheritance
            • Data privileges
              • View data privileges
              • Validate data privileges
              • Apply data privileges
              • View data privilege operation
              • Repair data privilege operation
              • View permission resources
              • Batch view permission resources
            • Object permissions
              • View object permission view
              • Validate object authorization
              • Apply object authorization
            • Application permissions
              • View permission schema
              • View current identity roles
              • Validate application permission policy
              • Apply application permission policy
        • Agent
          • Agent management
            • Agent
              • Query the list of agents
              • Query the details of the agent
              • Create the agent
              • Update agent
              • Delete agent
              • Query resource binding
              • Update resource binding
              • Update model binding
              • Query running strategy
              • Update run policy
              • Query the agent version
              • Delete agent version
              • Set as default version
              • Deactivate agent version
              • Bind operating environment
              • Re-coordinate the operating environment
            • Agent building
              • Generate candidate solutions
              • Query the current agent configuration
              • Regenerate candidate
              • Cancel candidate
              • Confirm candidate
              • Check available resources
            • Agent package
              • Load the agent package
              • Export agent package
            • Teams
              • Add a team member
              • Create a team conversation
              • Create an agent team
              • Delete an agent team
              • Get an agent team
              • Team versions, tasks, and deletion
              • List team members
              • Read team conversation messages
              • List team conversations
              • List agent teams
              • Team objects and request preparation
              • Remove a team member
              • Rename a team conversation
              • Submit a team message
              • Update an agent team
          • Resources and integrations
            • Agent model configuration
              • List available models
              • Query model configuration list
              • Query model configuration details
              • Create model configuration
              • Update model configuration
            • Agent knowledge base
              • Query knowledge base list
              • Query knowledge base details
              • Create agent knowledge base metadata
              • Update agent knowledge base metadata
            • Tools
              • Query tool list
              • Query tool details
              • Create tool
              • Update tool
              • Query tool tag
              • Query the agent that references this tool
              • Query GitHub tool connection
              • Save GitHub tool connection
              • Delete GitHub tool connection
              • Query Grafana tool connection
              • Save Grafana tool connection
              • Delete Grafana tool connection
              • Query email tool connection
              • Save email tool connection
              • Delete mail tool connection
              • Generate enterprise WeChat callback key
              • List connector services
              • Delete a skill
              • Delete a tool
              • Error contracts and environment validation
              • Workspace MCP tool import contract
              • Import MCP tools and bind an agent
              • Import Workspace MCP tools
            • Skills
              • Query skill list
              • Query skill details
              • Create skills
              • Update skills
              • Query skill tags
              • Execute skills
              • Streaming polishing skill draft
              • Check skill pack
              • Import skill pack
              • Query skill files
              • Download skill file
              • Query skill version
              • Set the current skill version
              • Query the agent that references this skill
              • Skill candidate confirmation
                • Candidate identity and request boundaries
                • Confirm saving a skill candidate
                • Errors, permissions, and environments
                • Get skill candidate save and binding status
                • Saving, binding, and failure recovery
            • Agent connection
              • Query connection list
              • Query connection details
              • Create connection
              • Update connection
              • Probe MCP connection
              • Batch creation MCP tool
            • Channel instance
              • Query instance list
              • Query instance details
              • Create instance
              • Update instance
              • Delete instance
              • Test the new configuration
              • Test created instance
            • Messaging connections
              • Create an incoming message connection
              • Delete an incoming message association
              • Get incoming message capabilities
              • Get an ingress connection
              • List target ingress connections
              • Message connections and knowledge reading objects
              • Get WeCom QR binding credentials
              • Update an ingress connection
              • Verify a callback ingress connection
            • Plugin connections and installations
              • Start plugin account authorization
              • Create a plugin account connection
              • Install a plugin
              • Delete a plugin account connection
              • Uninstall a plugin
              • Describe a plugin capability
              • Disconnect plugin account authorization
              • Get plugin account authorization status
              • Get plugin account connection details
              • Get plugin installation details
              • Get plugin release details
              • List plugin account connections
              • List plugin installations
              • List plugin releases
              • Plugin objects and states
              • Check a plugin account authorization attempt
              • Read a plugin skill file
              • Search plugin capabilities
              • Submit plugin account credentials
              • Update plugin account connection status
              • Update plugin installation bindings
          • Invocation and runtime
            • Call the agent
              • Get the agent call instructions
              • Called by other agents
              • Call from MCP client
            • Agent sessions
              • Query session list
              • Query session details
              • Create session
              • Update session
              • Query session messages
              • A2A methods, execution, and acknowledgement boundaries
              • Provider interaction responses and retries
              • Fork a conversation from an answer
            • Agent feedback
              • Query feedback
              • Query feedback statistics
            • Runtime state and records
              • Query runtime data sharding
              • Query the runtime task list
              • Query runtime task details
              • Query runtime task events
              • Query runtime list
              • Query runtime round snapshot
              • Run history errors and environments
              • List runs for an automation task
              • List workspace automation run history
              • Run history query rules
              • Automation run objects
            • Agent resource operation
              • Query resource operation list
              • Query resource operation details
              • Cancel resource operation
            • Agent catalog
              • List agent and team catalog cards
              • Group current conversations by agent
              • List agent conversation task records
            • Web applications
              • Get Web App feedback statistics
              • Get agent Web app publication records
              • Publication records, links, and history
              • List Web App visitor conversations
              • List Web application feedback
              • List Web app conversation messages
              • Web App administration objects
              • Rotate an agent Web application link
              • Enable or disable an agent Web application
              • Get site branding and login providers
            • Artifacts
              • Backfill historical agent artifacts
              • Batch delete agent artifacts
              • Artifact read, deletion, and backfill boundaries
              • Get an agent artifact version
              • List agent artifacts
              • Agent artifact objects
              • Resolve agent artifact file references
            • Agent home resources
              • Legacy sample copy protocol
              • Get Catalog file references for a home guide
              • Get the home sample language
            • UI conversations
              • Create a UI protocol session record
              • Delete a UI protocol session record
              • Toggle a UI protocol message dislike
              • Get UI protocol message details
              • Get UI protocol conversation details
              • Get the latest UI protocol message ID
              • Toggle a UI protocol message like
              • List UI protocol session messages
              • List pinned items from one ordinary session page
              • List UI protocol sessions
              • List unpinned UI protocol sessions
              • UI protocol conversation objects and read rules
              • Pin a UI protocol session
              • Compare UI and workspace LLM protocols
              • Unpin a UI protocol conversation
              • Update a UI protocol session record
          • Automation and workflows
            • Automation tasks
              • Query task list
              • Query task details
              • Create task
              • Update task
              • Archive task
              • Start task running
              • Query operation details
              • Query running events
              • Query the running results
            • Callback rules
              • Query callback rule list
              • Query callback rule details
              • Create callback rule
              • Update callback rule
              • Delete callback rule
            • Agent task templates
              • Query the list of agent task templates
              • Query the details of the agent task template
              • Create agent task template
              • Update agent task template
            • Workflow bindings
              • Query the agent workflow binding list
              • Query the agent workflow binding details
              • Create agent workflow binding
              • Update agent workflow binding
          • Runtime and system configuration
            • Runtime providers
              • Query runtime provider list
              • Query runtime provider Profile
            • Runtime policies
              • Query the running policy list
              • Query running policy details
              • Create run policy
              • Update run policy
            • System agent configuration
              • Query system agent configuration
              • Query the system agent GitHub project
              • Query system agent GitHub projects for new configuration
              • Update system agent configuration
        • Models
          • Model conversations
            • Add an LLM message tag
            • Add an LLM conversation tag
            • Append saved response text
            • Save an LLM session message
            • Create an LLM session record
            • Create a Workspace LLM tag
            • Delete an LLM session record
            • Delete a workspace LLM tag
            • Get LLM message details
            • Get LLM session details
            • Get the latest LLM message ID
            • Get LLM message tags
            • List LLM conversation messages
            • List LLM session tags
            • List LLM session records
            • List workspace LLM tags
            • Replace saved response text
            • Workspace LLM conversation objects and calling rules
            • Remove an LLM message tag
            • Remove an LLM conversation tag
            • Update an LLM session record
          • Model inference
            • Invoke a workspace chat model
            • Invoke a workspace embedding model
            • Workspace inference request fields
            • Workspace inference results and streaming protocol
            • Product model invocation common objects
          • Model fine-tuning
            • Cancel a nonterminal fine-tuning job
            • Create a fine-tuning job
            • Get fine-tuning job status and artifacts
            • Start a created fine-tuning job
            • Creation, scheduling, and result recovery
            • Fine-tuning job objects
            • Training inputs and execution environment
          • Model discovery and settings
            • List embedding routing models
            • List routed models
            • List workspace embedding models
            • Model discovery and probe objects
            • Probe models on a configured embedding backend
            • Probe embedding models
            • Probe models on a configured LLM backend
            • Probe LLM models
            • Configure an LLM backend and endpoint
          • Parser backends
            • Create a parser backend
            • Create a parser endpoint
            • Delete a parser backend
            • Get a parser backend
            • Get parser routing configuration
            • List parser backends
            • List parser endpoints
            • Parser management objects and calling rules
            • Save parser routing configuration
            • Set parser endpoint state
            • Update a parser backend
          • Model backends
            • Create an embedding backend through the root-level API
            • Create an embedding endpoint through the root-level API
            • Delete an embedding backend through the root-level API
            • Get an embedding backend through the root API
            • Get embedding routing through the root-level API
            • List embedding backends through the root API
            • List embedding endpoints through the root API
            • Update embedding routing configuration (root endpoint)
            • Set embedding endpoint status through the root API
            • Update an embedding backend through the root API
            • Create an LLM backend through the root API
            • Create an LLM endpoint through the root API
            • Delete an LLM backend through the root-level API
            • Get an LLM backend (root endpoint)
            • Get LLM routing configuration (root endpoint)
            • List LLM backends (root endpoint)
            • List LLM endpoints through the root API
            • Write LLM routing configuration through the root API
            • Set LLM endpoint status through the root API
            • Update an LLM backend (root endpoint)
            • Model backend administration objects and rules
            • Root and workspace update differences
            • Create an embedding backend through the workspace API
            • Create an embedding endpoint (workspace endpoint)
            • Delete an embedding backend (workspace endpoint)
            • Get an embedding backend (workspace endpoint)
            • Get embedding routing configuration through the workspace API
            • List embedding backends (workspace endpoint)
            • List embedding endpoints (workspace endpoint)
            • Write embedding routing configuration through the workspace API
            • Set embedding endpoint status through the workspace API
            • Update an embedding backend through the Workspace API
            • Create an LLM backend (workspace endpoint)
            • Create an LLM endpoint (workspace endpoint)
            • Delete an LLM backend (workspace endpoint)
            • Get an LLM backend through the Workspace API
            • Get LLM routing through the Workspace API
            • List LLM backends through the Workspace API
            • List LLM endpoints through the Workspace API
            • Write LLM routing through the Workspace API
            • Set LLM endpoint status through the workspace API
            • Update an LLM backend through the workspace API
      • Runtime protocols
        • Data dashboards
          • Dashboard WebSocket protocol
        • SQL execution
          • SQL WebSocket messages and sessions
        • Task knowledge
          • Select citations for a task answer
          • Describe task knowledge tables
          • Find task knowledge sources
          • Query structured knowledge within a task
          • Page through parsed task source text
          • Read knowledge evidence within a task
          • Find text in parsed task source content
          • Retrieve task image evidence
          • Retrieve task text evidence
        • Task files
          • Analyze a JPEG prepared by a child task
          • Child runtime and ordinary file identities
          • Image input and model conditions
          • Preview an agent query chart image
          • Publish a child-task file artifact
          • Artifact publication, retry, and confirmation
          • Read a temporary connector file stream
        • MCP applications
          • Call a task MCP App tool
          • Read task MCP App resources
          • Task scope and result reads
        • Web applications
          • Archive a visitor conversation
          • Create a visitor Web app conversation
          • Create a visitor session
          • Download a visitor task artifact
          • Public links and visitor identity
          • List this visitor's conversations
          • Read visitor task events incrementally
          • Read visitor conversation messages
          • Call an MCP App tool for a visitor task
          • Read an MCP application resource for a visitor task
          • Public Web application objects
          • Preview visitor task artifacts
          • Refresh the same visitor session
          • Change a visitor conversation title
          • Resolve a public Web app link
          • Send a visitor message and read the event stream
          • Visitor event streams and file boundaries
          • Submit visitor feedback
          • Upload a visitor attachment
        • Browser and agent communication
          • Connect to a task browser stream
          • Get a short-lived task browser token
          • Browser messages and input
          • Restricted runtime agent build commands
          • Identity, errors, and environments
          • Restricted runtime building and skill snapshots
          • Download skill files bound to a runtime as ZIP
      • Platform administration
        • AI Studio
          • Service slots
            • List models assignable to a slot
            • List service slot operation logs
            • List AI Studio service slots
            • Replace a service slot model configuration
            • Slot definitions and object rules
            • Writes, rereads, and environment state
          • Compute resources
            • Submit an administrative compute resource deletion
            • Compute administration errors and recovery
            • List compute resources as an administrator
            • Compute administration common objects
            • Preflight compute resource deletion
            • Update administrative compute resource configuration
            • Compute administration lifecycle errors and recovery
            • Get compute resource runtime state as an administrator
            • Compute administration runtime and lifecycle common objects
            • Resume a compute resource
            • Retry a compute resource
            • Suspend a compute resource
          • Sandboxes
            • Delete a managed sandbox
            • Sandbox administration errors, recovery, and environments
            • Get sandbox administration details
            • List sandboxes for administration
            • Sandbox administration common objects
            • Replace a managed sandbox network allowlist
            • Update sandbox quotas for a target Workspace
        • Genesis
          • Feedback tickets
            • Approve a feedback ticket reward
            • Generate a GitHub Issue draft from a ticket
            • Submit a request to create a ticket GitHub Issue
            • Administrative ticket errors, asynchronous states, and environments
            • Get administration ticket details
            • List administrative tickets
            • Feedback ticket administration common objects
            • Update an administration ticket status and reply
Back to top
Reference › SQL Reference › Functions › JSON Functions

JSON Functions¶

  • JQ()
  • JSON_EXTRACT()
  • JSON_EXTRACT_FLOAT64()
  • JSON_EXTRACT_STRING()
  • JSON_QUOTE()
  • JSON_ROW()
  • JSON_UNQUOTE()
  • TRY_JQ()
Last updated on Nov 16, 2026
JQ()
ROW_NUMBER()
Copyright © 2026, MatrixOrigin
Made with Sphinx and @pradyunsg's Furo