List connector services

Read connector services in the agent resource center and their current configuration flags. This catalog includes search, monitoring, cluster, and email services; it is not a list of data connector instances.

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/connector-catalog

Before you call this API

Obtain a personal access token and workspace ID for the current environment as described in AI Studio. The current effective role must permit the action.

Query parameters

curl --get "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/connector-catalog" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter

Type

Required

Description

workspace_id

string

Yes

Target workspace ID in the current environment, matching the header.

X-Workspace-ID

string

Yes

Workspace ID in the current environment.

X-API-Key

string

Yes

Personal access token in the current environment.

No pagination, name, or provider filter parameters. All eight configured flags in the example are false, indicating only that this example workspace has no enabled configuration.

Successful response

{
  "code": 0,
  "data": {
    "items": [
      {
        "provider": "bocha",
        "name": "博查 Web Search",
        "description": "配置博查 API Key 后使用网页搜索。",
        "configured": false
      },
      {
        "provider": "tavily",
        "name": "Tavily Web Search",
        "description": "配置 Tavily API Key 后使用网页搜索。",
        "configured": false
      },
      {
        "provider": "brave",
        "name": "Brave Search",
        "description": "配置 Brave Search Subscription Token 后使用网页搜索。",
        "configured": false
      },
      {
        "provider": "deepseek",
        "name": "DeepSeek",
        "description": "配置工作区 DeepSeek Search/Fetch 服务后搜索和获取公开网页。",
        "configured": false
      },
      {
        "provider": "grafana",
        "name": "Grafana",
        "description": "Grafana 健康状态、数据源、Prometheus 和 Loki 查询能力。",
        "configured": false
      },
      {
        "provider": "kubernetes",
        "name": "Kubernetes",
        "description": "Kubernetes Namespace、Node、Pod、Deployment、Service 和 Event 读取能力。",
        "configured": false
      },
      {
        "provider": "mail",
        "name": "标准邮箱",
        "description": "通过标准 IMAP/SMTP 收取和发送邮件。",
        "configured": false
      },
      {
        "provider": "qq_mail",
        "name": "QQ 邮箱",
        "description": "通过 IMAP/SMTP 连接 QQ 邮箱,读取、搜索邮件并查看附件。",
        "configured": false
      }
    ]
  }
}

Field

Type

Description

code

integer

0 on success.

data.items

object (array of objects)

Current catalog entries; this API does not paginate.

data.items[].provider

string

Service provider identifier for subsequent connector selection.

data.items[].name

string

Service name in the current language.

data.items[].description

string

Service description in the current language.

data.items[].configured

boolean

true when the current workspace has an active/channel configuration for this provider. This is not a connectivity test result.

Error responses

HTTP / code

Conditions and handling

400 / 2

Parameter errors such as an invalid workspace identifier.

403 / 5

Current authorization denied.

503 / 15

Connector or authorization dependencies unavailable.

The authentication stage may also return string code/msg. See errors and environments.

Last updated on