---
orphan: true
---
# 创建连接

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

创建智能体可引用的连接元数据和凭据引用。

```text
POST https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/connections
```

## 调用前准备

准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/connections" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "MCP 服务",
    "kind": "mcp_server",
    "endpoint_uri": "https://mcp.example.com"
  }'
```

:::::
:::::{tab-item} 参数说明

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `name` | string | 是 | 连接名称。 |
| `endpoint_uri` | string | 是 | 连接服务地址。 |
| `description` | string | 否 | 连接说明。 |
| `status` | string | 否 | 连接状态。 |
| `kind` | string | 否 | 连接类型。 |
| `auth_type` | string | 否 | 认证类型。 |
| `credential_ref` | string | 否 | 已保存凭据的引用。 |
| `capabilities` | string（字符串数组） | 否 | 连接能力列表。 |
| `owner_user_id` | string | 否 | 连接所有者用户 ID。 |
| `visibility` | string | 否 | 可见范围。 |
| `config` | object | 否 | 连接配置。 |
| `labels` | object | 否 | 标签。 |
| `annotations` | object | 否 | 注释。 |
| `metadata` | object | 否 | 扩展元数据。 |
| `credential` | object | 否 | 凭据，可包含 bearer_token、api_key、basic_username、basic_password 或 custom_headers。 |
| `bearer_token` | string | 否 | Bearer Token。 |
| `api_key` | string | 否 | API Key。 |
| `basic_username` | string | 否 | Basic 认证用户名。 |
| `basic_password` | string | 否 | Basic 认证密码。 |
| `custom_headers` | object | 否 | 自定义请求头。 |

:::::
::::::
:::::::

## 成功响应

成功时返回 `201` 和新连接。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{"code":0,"data":{"id":"connection_01","name":"MCP 服务"}}
```

:::::
:::::{tab-item} 字段说明

::::{tab-set}

:::{tab-item} 基础信息

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `data.id` | string | 新连接 ID。 |

:::

::::

:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{"code":2,"message":"invalid connection metadata"}
```

:::::
:::::{tab-item} 字段说明

::::{tab-set}
:::{tab-item} 通用字段

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 错误代码。 |
| `message` | string | 面向调用者的错误信息。 |

:::
::::

:::::
::::::
:::::::