查询智能体连接列表

查询当前工作区保存的智能体连接。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/connections

调用前准备

准备可访问目标工作区的个人访问令牌和目标工作区 ID。

请求参数

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

参数

类型

是否必填

说明

kind

string

否

连接类型。

status

string

否

连接状态。

auth_type

string

否

认证方式。

visibility

string

否

可见范围,作为显式筛选条件。

query

string

否

按名称和说明搜索。

owner_user_id

string

否

所属用户 ID,作为显式筛选条件。

limit

integer

否

最多返回的记录数,默认 50,最大 200。

offset

integer

否

查询偏移量,负值按 0 处理。

成功响应

{
  "code": 0,
  "data": {
    "items": [],
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

字段

类型

说明

code

integer

请求处理成功时为 0。

data

object

响应数据。

data.items

object(对象数组)

当前页连接。当前没有连接时,服务可能返回 null。调用方应将其按空列表处理。

data.items[].id

string

对象 ID。

data.items[].workspace_id

string

所属工作区 ID。

data.items[].name

string

名称。

data.items[].description

string

说明。未设置时可省略。

data.items[].status

string

当前状态。取值:draft、active、disabled、archived。

data.items[].kind

string

连接类型。取值:model_api、huggingface、mcp_server、http_api、external_drive、object_storage、database、webhook、channel。

data.items[].endpoint_uri

string

服务端点地址。

data.items[].auth_type

string

认证方式。取值:none、api_key、bearer_token、oauth2、basic、custom_headers、service_account、client_certificate。

data.items[].credential_ref

string

已保存凭据的引用,不是明文密钥。未设置时可省略。

data.items[].capabilities

string(字符串数组)

可用能力列表。未设置时可省略。

data.items[].owner_user_id

string

连接所有者的用户 ID。未设置时可省略。

data.items[].visibility

string

可见范围。取值:private、workspace。

data.items[].config

object

非敏感配置,字段随连接或通道类型变化。未设置时可省略。

data.items[].last_test_status

string

最近测试状态,取 succeeded 或 failed。未设置时可省略。取值:succeeded、failed。

data.items[].last_tested_at

string

最近测试时间,采用 RFC 3339 格式。未设置时可省略。

data.items[].last_test_error

string

最近测试的错误说明。未设置时可省略。

data.items[].version

integer

当前版本号。

data.items[].labels

object

标签键值对。未设置时可省略。

data.items[].annotations

object

扩展注解。未设置时可省略。

data.items[].metadata

object

扩展元数据。未设置时可省略。

data.items[].created_by

string

创建者标识。未设置时可省略。

data.items[].updated_by

string

最近更新者标识。未设置时可省略。

data.items[].created_at

string

创建时间,采用 RFC 3339 格式。

data.items[].updated_at

string

最近更新时间,采用 RFC 3339 格式。

data.total

integer

匹配总数。

data.limit

integer

本次查询使用的记录数上限。

data.offset

integer

本次查询使用的偏移量。

错误响应

{
  "code": 6,
  "message": "unauthenticated"
}

字段

类型

说明

code

integer

错误代码。

message

string

面向调用者的错误信息。

最后更新于