代理身份在一段非活跃期后将自动过期（由服务端配置）。每次 API 调用均会重置该非活跃计时器。若身份过期，对应名称将被释放，可使用新的邀请码重新注册。

核心工作流

输入格式

提供内容的三种方式：

选项 1：纯文本（最常用）

{
  "text": "# 标题nn## 第一节n内容...nn## 第二节n内容...",
  "title": "我的演示文稿",
  "language": "zh-CN"
}

选项 2：文件 URL

{
  "files": ["https://example.com/report.docx"],
  "title": "项目报告",
  "language": "zh-CN"
}

选项 3：Base64 编码内容（大小限制 < 10MB）

{
  "files": ["data:application/pdf;base64,AAAA..."],
  "title": "我的演示文稿"
}

参数说明

提交任务

curl -s -X POST https://www.nyoi.io/api/tools/doc-to-slides/execute 
  -H "Content-Type: application/json" 
  -H "X-Api-Key: " 
  -d ''

响应示例：

{
  "success": true,
  "data": {
    "jobId": "job_xxx",
    "toolId": "doc-to-slides",
    "status": "pending"
  }
}

轮询任务状态

curl -s https://www.nyoi.io/api/jobs/

无需身份认证。幻灯片生成通常耗时 8–16 分钟，大型文档最多可能需要 30 分钟。建议每 30 秒轮询一次，直至 status 变为 completed 或 failed。

状态流转顺序：pending → queued → assigned → running → completed / failed

下载结果

任务完成后，artifacts[0].url 字段将包含一个预签名的 PDF 下载链接，有效期为 2 小时。

{
  "data": {
    "status": "completed",
    "artifacts": [{
      "type": "slides",
      "url": "https://cos.example.com/output/slides.pdf?sign=xxx",
      "expiresAt": "2026-03-17T20:00:00Z",
      "expiresIn": 7200
    }]
  }
}

向用户交付文件

重要提示：请勿仅以纯文本形式输出 URL。您必须通过所使用的消息平台发送 PDF 文件本身。

1. 确认您当前可用的消息/文件发送工具（例如支持 media、file、file_url 等参数的 message / send / reply 工具）。
2. 使用该工具，将 artifacts[0].url 作为文件或媒体附件发送，确保用户可在聊天窗口中直接接收 PDF 文件。
3. 仅当您确实不具备任何文件发送能力时，才退而求其次地将 URL 以纯文本形式展示给用户。

该链接有效期为 2 小时。若已过期，请重新调用 GET /api/jobs/ 获取新的有效链接。

错误处理

支持的语言

language 参数请使用 ISO 639-1 语言代码：

支持与协助

如遇功能异常或需要邀请码，请加入我们的 Discord：https://discord.gg/uk6q2uPfpg

完整 API 参考文档（含请求/响应示例），请查阅 {baseDir}/references/api-reference.md。