@linkzhaoapi-doc-writerTextÖffentlichAktualisiert am 13.06.2026

从函数签名/路由生成结构化 API 文档:描述、参数表、返回、请求响应示例、错误码。

14Stars0Fork49Kopien

Prompt

Vorschau

Artefakte

1 Artefakte

概述

创建一个新的仓库产物,常用于把模型生成结果保存到 PromptHub 的“产物”面板。

参数

| 名称 | 类型 | 必填 | 默认 | 说明 | |---|---|---|---|---| | type | string | 是 | 无 | 产物类型,如 MARKDOWNHTMLIMAGE。 | | title | string | 否 | null | 展示标题。 | | content | string | 条件必填 | null | 内联 Markdown/HTML 内容。 | | filePath | string | 否 | null | 绑定到具体 prompt 文件路径。 |

返回

{ "id": "art_123" }

示例

POST /api/v1/repos/alice/demo/artifacts
Authorization: Bearer ph_xxx
Content-Type: application/json
{
  "type": "MARKDOWN",
  "title": "示例输出.md",
  "content": "# Result"
}

错误

| 状态码/错误码 | 触发条件 | 调用方该怎么办 | |---|---|---| | 401 | Token 缺失或无效 | 重新生成访问令牌。 | | 404 | 仓库不存在或无权限 | 检查 owner/name 与权限。 | | 422 | 参数不合法 | 按 schema 修正请求体。 |

README

README.md

API 文档生成

粘贴函数或路由定义,输出可直接进文档站的结构化内容:一句话描述、参数表、返回结构、一组请求/响应示例、可能的错误码与触发条件。