AI Studio Product API¶

AI Studio 的程序化接入不是一个覆盖全部产品对象的统一 REST 管理端点。当前文档确认的对外路径包括：

将 Catalog 中的系统算子或自定义算子发布为 REST 服务；
使用 Catalog 生成的 SQL 连接信息，从支持 MySQL 协议的客户端查询数据；
通过 REST API 或 GraphQL 连接器把外部数据载入 Catalog；
通过 Webhook 将处理结果或已开放的事件推送给外部系统。

本快速开始以最直接的算子 API为例。算子的 URL、请求字段和响应结构由发布配置与算子签名决定，不能跨服务套用固定请求体。

发布前确认¶

开始前需要在目标 AI Studio 工作区中准备一个可运行的算子，并具备发布和使用该资源所需的权限。发布时确认：

输入参数的名称、类型、必填项和默认值；
服务的认证方式：API Key、OAuth 2.0 或公开访问；
超时、最大并发和调用频率等运行限制；
算子所需的计算资源或模型服务可用。

在算子详情的 API 服务区域复制完整服务地址，并以页面生成的接口说明为调用契约。若界面未显示发布或 API 服务入口，可能是权限、部署模式或功能开关不同；不要改用浏览器内部请求地址。

配置调用参数¶

以下示例假设服务使用 API Key 认证。Genesis API Key 可以作为算子服务的一种默认认证选择，但最终以发布配置为准。

export OPERATOR_ENDPOINT='https://<full-operator-endpoint>'
export OPERATOR_API_KEY='<api-key-configured-for-this-service>'

OPERATOR_ENDPOINT 应是详情页提供的完整地址。不要自行追加推测的版本号或路径。

根据算子签名发送请求¶

假设该算子公开一个名为 input 的字符串参数，请求可以写成：

curl --fail-with-body --silent --show-error \
  "$OPERATOR_ENDPOINT" \
  -X POST \
  -H "Authorization: Bearer $OPERATOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "需要处理的内容"
  }'

这里的 input 只是示例。实际服务可能要求多个字段、不同类型或不同的嵌套结构，必须按 API 服务页面显示的请求示例调整。响应也由算子输出签名决定，不要假设结果一定在 data、result 或其他固定字段中。

如果服务配置为公开访问，按页面说明省略认证头；如果配置为 OAuth 2.0，应先从配置的授权服务器取得访问令牌。不要同时发送多套凭据。

验证与排错¶

首次接入时，先用页面中的试用功能或最小 curl 请求验证，再集成到应用。至少检查：

检查项	预期
HTTP 状态	为成功状态；失败时保留响应体用于定位
输出结构	与当前算子版本的输出签名一致
认证	使用发布配置指定的方式，Key 或令牌没有写入日志
运行限制	请求耗时、并发和频率不超过服务配置
版本变更	修改算子输入或输出后，同步更新调用方并重新验证

算子调用是同步的。需要较长时间或多步骤处理时，应编排为工作流，再通过产品提供的作业状态或 Webhook 获取结果；不要假设算子端点会自动返回异步任务 ID。

选择其他接入方式¶

需求	合适的入口
从 BI 工具、数据库客户端或驱动查询 Catalog 库表	使用 Catalog 生成的 SQL 连接串；具体 host、port、用户、密码和 database 以控制台为准
定时从第三方 HTTP API 读取数据	配置 REST API 或 GraphQL 数据源及载入任务
把处理结果推送到外部服务	配置 Webhook，并按实际签名算法校验来源
直接调用对话、Embedding 或 Rerank 模型	使用 Genesis API，不要绕经 Product API
管理知识库、智能体或工作流	仅使用当前部署明确发布的接口；本文档尚未提供稳定的统一 OpenAPI