{"id":29623930,"url":"https://github.com/metaglm/devbook","last_synced_at":"2025-07-21T05:08:28.590Z","repository":{"id":305093568,"uuid":"1020829628","full_name":"MetaGLM/devbook","owner":"MetaGLM","description":"Source of Developer Docs for ZhiPu AI Platform","archived":false,"fork":false,"pushed_at":"2025-07-18T10:07:39.000Z","size":308,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-18T10:19:53.582Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MetaGLM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-16T13:07:32.000Z","updated_at":"2025-07-17T12:49:58.000Z","dependencies_parsed_at":"2025-07-18T10:19:58.271Z","dependency_job_id":null,"html_url":"https://github.com/MetaGLM/devbook","commit_stats":null,"previous_names":["metaglm/devbook"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/MetaGLM/devbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaGLM%2Fdevbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaGLM%2Fdevbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaGLM%2Fdevbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaGLM%2Fdevbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MetaGLM","download_url":"https://codeload.github.com/MetaGLM/devbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaGLM%2Fdevbook/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266242072,"owners_count":23898102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-21T05:08:28.104Z","updated_at":"2025-07-21T05:08:28.581Z","avatar_url":"https://github.com/MetaGLM.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZHIPU AI 开发者文档\n\n智谱 AI 平台开发者文档的源代码仓库，基于 Mintlify 构建的现代化文档站点。\n\n## 🚀 快速开始\n\n### 环境要求\n\n- Node.js 16.0 或更高版本\n- npm 或 yarn 包管理器\n\n### 本地开发\n\n1. **安装 Mintlify CLI**\n   ```bash\n   npm i -g mint\n   ```\n\n2. **克隆项目**\n   ```bash\n   git clone \u003crepository-url\u003e\n   cd devbook\n   ```\n\n3. **启动开发服务器**\n   ```bash\n   mint dev\n   ```\n   \n   服务器将在 `http://localhost:3000` 启动，支持热重载。\n\n4. **OPENAPI定义校验**\n\n\u003e OPEN API 接口的定义基于 OPENAPI 3.0.1 规范，在 `openapi/openapi.json` 文件中定义。\n\n  校验 `openapi.json` 是否符合 OPENAPI 3.0.1 规范\n   ```bash\n   mint openapi-check openapi/openapi.json\n   ```\n\n5. **断链校验**\n   ```bash\n   mint broken-links\n   ```\n\n**[`OEPNAPI`接口定义](openapi/openapi.json) 推荐使用 https://editor.swagger.io/ 在线编辑，或使用 Webstorm 本地编辑可视化**\n\n## 项目结构\n\n```\ndevbook/\n├── cn/ # 中文文档\n│ ├── api/ # API 文档\n│ │ ├── agents/ # 智能体相关\n│ │ ├── audio/ # 音频相关\n│ │ ├── chat/ # 聊天对话相关\n│ │ ├── embedding/ # 文本嵌入相关\n│ │ ├── file/ # 文件管理相关\n│ │ ├── image/ # 图像生成相关\n│ │ ├── tools/ # 工具相关\n│ │ └── video/ # 视频生成相关\n│ ├── guide/ # 使用指南\n│ ├── issue/ # 常见问题\n│ └── update/ # 更新日志\n├── en/ # 英文文档\n│ ├── api/ # API 文档\n│ │ ├── agents/ # 智能体相关\n│ │ ├── audio/ # 音频相关\n│ │ ├── chat/ # 聊天对话相关\n│ │ ├── embedding/ # 文本嵌入相关\n│ │ ├── file/ # 文件管理相关\n│ │ ├── image/ # 图像生成相关\n│ │ ├── tools/ # 工具相关\n│ │ └── video/ # 视频生成相关\n│ ├── guide/ # 使用指南\n│ ├── issue/ # 常见问题\n│ └── update/ # 更新日志\n├── openapi/ # OpenAPI 规范文件\n│ └── openapi.json # 完整的 OpenAPI 规范（主入口，已模块化合并）\n├── resource/ # 静态资源\n│ ├── favicon.svg\n│ ├── logo_icon.png\n│ └── logo.png\n├── style.css # 样式文件\n├── docs.json # 文档配置\n├── LICENSE # 许可证\n├── CONTRIBUTING.md # 贡献指南\n└── CODE_OF_CONDUCT.md # 行为准则\n```\n\n## OpenAPI 规范文件\n\n项目采用模块化设计，但当前仅保留合并后的主入口文件 `openapi/openapi.json`，该文件包含所有 API 的完整 OpenAPI 3.0.1 规范定义。\n\n### 主要 API 模块与路径\n\n- **聊天对话 API**\n  - `/paas/v4/chat/completions` - 聊天补全\n\n- **文本嵌入 API**\n  - `/paas/v4/embeddings` - 文本嵌入\n\n- **音频处理 API**\n  - `/paas/v4/audio/speech` - 文本转语音\n  - `/paas/v4/audio/transcriptions` - 语音转文本\n  - `/paas/v4/audio/customization` - 语音定制\n\n- **图像生成 API**\n  - `/paas/v4/images/generations` - 图像生成\n\n- **视频生成 API**\n  - `/paas/v4/videos/generations` - 视频生成\n  - `/paas/v4/async-result/{id}` - 异步结果查询\n\n- **文件管理 API**\n  - `/paas/v4/files` - 文件上传与列表\n  - `/paas/v4/files/{file_id}` - 文件信息获取与删除\n  - `/paas/v4/files/{file_id}/content` - 文件内容下载\n\n- **工具 API**\n  - `/paas/v4/web_search` - 网络搜索\n  - `/paas/v4/tools` - 综合网络搜索\n\n- **助手 API**\n  - `/paas/v4/assistant` - 助手对话\n  - `/paas/v4/assistant/list` - 查询助手支持能力\n  - `/paas/v4/assistant/conversation/list` - 查询助手对话统计\n\n- **批处理任务 API**\n  - `/paas/v4/batches` - 创建与列出批处理任务\n  - `/paas/v4/batches/{batch_id}` - 获取批处理任务详情\n  - `/paas/v4/batches/{batch_id}/cancel` - 取消批处理任务\n\n- **知识库 API**\n  - `/knowledge` - 创建与获取知识库列表\n  - `/knowledge/{id}` - 编辑、获取详情、删除知识库\n  - `/knowledge/capacity` - 获取知识库使用量详情\n\n- **知识库文档 API**\n  - `/document/upload_document/{id}` - 向知识库上传文档\n\n- **智能体（Agent）API**\n  - `/v1/agents` - 智能体对话\n  - `/v1/agents/async-result` - 查询智能体异步结果\n\n\u003e 详细字段、参数和响应格式请参考 [openapi/openapi.json](openapi/openapi.json) 文件或使用 Swagger 编辑器进行可视化浏览。\n\n## 贡献指南\n\n欢迎贡献代码和文档！请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详细的贡献流程。\n\n## 许可证\n\n本项目采用 MIT 许可证，详见 [LICENSE](LICENSE) 文件。\n\n## 联系我们\n\n- 官网：https://open.bigmodel.cn/\n- 开发者社区：https://chat.z.ai/\n- 邮箱：user_feedback@z.ai","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetaglm%2Fdevbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetaglm%2Fdevbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetaglm%2Fdevbook/lists"}