# 摩笔天书API # ！说明以下所有请求的请求头中必须包含 Authorization: . token字符串长度为64 用真实值替换，可向管理员申请示例 curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: "\ -d '{"text": "dog", "height": 512, "width": 512, "seed": 2022, "fast": false}' \ http://tianshu-test.mthreads.com/tianshu/general/submit # 天书API域名生产环境URL： http://api.mthreads.com ## 1 创建故事 ### 1.1 V1.0版本接口（默认生成视频） ### 接口 /tianshu/api/v1/createStory ### 类型 POST ### 参数 | 名称 | 类型 | 备注 | | --- | --- | --- | | storyTitle | String | 故事标题，不超过10个字 | | storyDescription | String | 故事描述，不超过200字 | | dubbing | String | 配音，可选参数： 1 温柔女声： LYG1004 2 萌趣童声： babyx 3 活力童声： boyten | | bgm | String | 背景音乐： 1 春日郊游 BGM\_01.wav 2 探索发现 BGM\_02.wav 3 小侦探 BGM\_03.wav | | volume | String | 音量 1 - 72之间的参数 | | font | String | 字体： 1 抖音美好体 DouyinSansBold 2 阿里巴巴普惠体 Alibaba-PuHuiTi-Light 3 猫啃什锦体 MaokenAssortedSans 4 荆南麦圆体 jingnanmaiyuan 5 思源黑体 SourceHanSansCN-Light 6 思源宋体 SourceHanSerifCN-Light-5 7 字魂扁桃体 zihunbiantao | | fontSize | String | 字号 1-72 | | fontColor | String | 字体颜色，十六进制颜色码示例： #00FF00 | | backgroundColor | String | 背景色,十六进制颜色码示例： #FFFFFF | | videoRatio | String | 视频尺寸: 1:1 4:3 3:4 | | videoResolution | String | 视频清晰度: 标清： SD 高清： HD | ### 返回 * 状态码: 200 OK | 名称 | 类型 | 备注 | | --- | --- | --- | | userStory | Object | 提交的故事数据 | * userStory 内容 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | userId | String | 用户ID | | userName | String | 用户名 | | taskId | String | 任务ID | | storyTitle | String | 故事标题 | | storyCover | String | 故事封面 | | storyDescription | String | 故事描述 | | storyVideo | String | 视频URL | | storyProcess | String | 生成进度 | | advanceSetting | String | 高级设置，格式为JSON | | createTime | LocalDateTime | 创建日期 | | modifyTime | LocalDateTime | 修改日期 | | status | String | 故事状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | ### 示例 #### 请求 curl --location 'http://api.mthreads.com/tianshu/v1/createStory' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ "storyDescription": "小明是宇宙超人，在宇宙中探索", "storyTitle": "宇宙探索", "backgroundColor": "#FFFFFF", "bgm": "BGM_03.wav", "dubbing": "LYG1004", "font": "MaokenAssortedSans", "fontColor": "#000000", "fontSize": "14", "videoDuration": "short", "videoRatio": "1:1", "videoResolution": "SD", "volume": "30" }' #### 返回 { "userStory": { "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-28 16:13:36.200", "delTag": 1, "id": 177, "status": "CREATED", "storyDescription": "小明是宇宙超人，在宇宙中探索", "storyProcess": "0", "storyTitle": "宇宙探索", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "userId": "6539cbedf1667d5c87d01369", "userName": "开发者" } } ### 1.2 生成故事（视频可选，支持风格定制等） ### 接口 /tianshu/api/v1/createTaskStory ### 类型 POST ### 参数 | 名称 | 类型 | 备注 | | --- | --- | --- | | storyTitle | String | 故事标题，不超过10个字 | | storyDescription | String | 故事描述，不超过200字 | | dubbing | String | 配音，可选参数： 1 温柔女声： LYG1004 2 萌趣童声： babyx 3 活力童声： boyten | | bgm | String | 背景音乐： 1 春日郊游 BGM\_01.wav 2 探索发现 BGM\_02.wav 3 小侦探 BGM\_03.wav | | volume | String | 音量 1 - 72之间的参数 | | font | String | 字体： 1 抖音美好体 DouyinSansBold 2 阿里巴巴普惠体 Alibaba-PuHuiTi-Light 3 猫啃什锦体 MaokenAssortedSans 4 荆南麦圆体 jingnanmaiyuan 5 思源黑体 SourceHanSansCN-Light 6 思源宋体 SourceHanSerifCN-Light-5 7 字魂扁桃体 zihunbiantao | | fontSize | String | 字号 1-72 | | fontColor | String | 字体颜色，十六进制颜色码示例： #00FF00 | | backgroundColor | String | 背景色,十六进制颜色码示例： #FFFFFF | | videoRatio | String | 视频尺寸: 1:1 4:3 3:4 | | videoResolution | String | 视频清晰度: 标清： SD 高清： HD | | videoDuration | String | 视频长度：short, mid, long | | needVideo | Bool | 是否需要生成视频，默认false | | artStyle | String | 图片风格: 默认 default 可爱 cute 漫画 manga 鲜艳 bright 玩具 toy 3D 3d 粘土 clay 折纸 origami 剪纸 kirigami 卷纸 paper_quilling 赛博朋克 cyberpunk 霓虹朋克 neonpunk 蒸汽朋克 steampunk 生化朋克 bio_cyberpunk 朋克拼贴 punk_collage 水彩 watercolor 炫彩 alcohol_ink 喷墨 drip 像素 pixel 方块 block 低聚 lowpoly 暗黑 dark 哥特 gothic 刺绣 embroidery 迪士科 disco 蒸汽波 vaporwave 复古 renaissance | ### 返回 * 状态码: 200 OK | 名称 | 类型 | 备注 | | --- | --- | --- | | userStory | Object | 提交的故事数据 | * userStory 内容 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | userId | String | 用户ID | | userName | String | 用户名 | | taskId | String | 任务ID | | storyTitle | String | 故事标题 | | storyCover | String | 故事封面 | | storyDescription | String | 故事描述 | | storyVideo | String | 视频URL | | storyProcess | String | 生成进度 | | advanceSetting | String | 高级设置，格式为JSON | | createTime | LocalDateTime | 创建日期 | | modifyTime | LocalDateTime | 修改日期 | | status | String | 故事状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | ### 示例 #### 请求 curl --location 'http://api.mthreads.com/tianshu/v1/createStory' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{ "storyDescription": "小明是宇宙超人，在宇宙中探索", "storyTitle": "宇宙探索", "videoDuration": "short", "artStyle": "cute", "videoRatio": "1:1", "videoResolution": "SD", "dubbing": "LYG1004", "bgm": "BGM_03.wav", "volume": 30, "font": "MaokenAssortedSans", "fontSize": "24", "fontColor": "#FFFFFF", "backgroundColor": "#FFFFFF00", "needVideo": false }' #### 返回 { "userStory": { "advanceSetting": "{\"artStyle\":\"cute\",\"backgroundColor\":\"#FFFFFF00\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#FFFFFF\",\"fontSize\":\"24\",\"needVideo\":false,\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2024-05-13 20:46:00.247", "delTag": 1, "id": 309, "liked": false, "status": "CREATED", "storyDescription": "", "storyProcess": "0", "storyTitle": "大公鸡", "storyType": "tianshu-maliang-queue", "taskId": "f8be2bcb-b374-40c3-9a67-18223fc9d9c9", "userId": "qM27O4ZwiFa0LS1Lib9lQ2MToZTKh0pwEFJ52R28rcBiSK6y8CCUEH8BMti0KIzz", "userName": "开发者" } } ## 2 查看作品详情 ### 接口 /tianshu/api/v1/storyDetail ### 类型 GET ### 参数以下两个ID 任选一个传入即可查询出详情 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | shareId | String | 分享ID | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | userStory | Object | 提交的故事数据 | | userStoryDetailList | Object | 故事详情列表 | * userStory 内容 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | userId | String | 用户ID | | userName | String | 用户名 | | taskId | String | 任务ID | | storyTitle | String | 故事标题 | | storyCover | String | 故事封面，非单独生成的图片，一般取详情列表的第一张图片做封面 | | storyDescription | String | 故事描述 | | storyVideo | String | 视频URL | | storyProcess | String | 生成进度 | | advanceSetting | String | 高级设置，格式为JSON | | createTime | LocalDateTime | 创建日期 | | modifyTime | LocalDateTime | 修改日期 | | status | String | 故事状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | * userStoryDetailList 内容 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | ID | | userId | String | 用户ID | | taskId | String | 任务ID | | storyId | Long | 故事ID | | storyPage | Integer | 页码 | | storyContext | String | 故事正文 | | storyImage | String | 图片地址 | | storyAudio | String | 故事单句语音 | | createTime | LocalDateTime | 创建时间 | | modifyTime | LocalDateTime | 修改时间 | | status | String | 生成状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | ### 示例 #### 请求 curl --location 'http://api.mthreads.com/tianshu/v1/storyDetail?id=151' \ --header 'Authorization: Bearer ' #### 返回 { "userStory": { "id": 177, "userId": "6539cbedf1667d5c87d01369", "userName": "开发者", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyTitle": "宇宙探索", "storyCover": null, "storyVideo": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/宇宙探索.mp4", "storyProcess": "100", "storyDescription": "小明是宇宙超人，在宇宙中探索", "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-28T16:13:36", "modifyTime": "2023-11-28T16:21:52", "status": "FINISHED", "delTag": 1 }, "userStoryDetailList": [ { "id": 1570, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 0, "storyContext": "在遥远的未来，有一个小男孩名叫小明。他是一位聪明勇敢的少年，他的家乡正面临着一场空前的大灾难——太空垃圾污染。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/3a2db207e13d2e62f00c441963379caa.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/202311284440a0d666895342fc1e64e6fd938b13.wav", "createTime": "2023-11-28T16:21:52", "modifyTime": null, "status": "FINISHED" }, { "id": 1571, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 1, "storyContext": "为了拯救家园，人们需要找到一种方法来清理太空垃圾，而这一切都源于一位神秘的宇宙超人的英勇行为。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/138089844a5a31d5542df07f60238e0f.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/202311285466e143bdc7edb0dee7a4ace7e9c4e8.wav", "createTime": "2023-11-28T16:21:58", "modifyTime": null, "status": "FINISHED" }, { "id": 1572, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 2, "storyContext": "这位宇宙超人的名字叫做“小飞”，他拥有无尽的力量和智慧，能够飞到太空中各个星球，将垃圾清扫干净。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/1893788973f0d67963a09152c737c9da.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/20231128ad568b927e022c5bbc20d22a81345c70.wav", "createTime": "2023-11-28T16:22:03", "modifyTime": null, "status": "FINISHED" }, { "id": 1573, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 3, "storyContext": "小明决定利用自己的智慧和勇气去帮助那些需要帮助的人们。在一次偶然的机会里，小明发现了一颗神秘的星星，这颗星星上漂浮着无数的垃圾和废墟，这让他意识到，如果不把这些垃圾清理干净，地球将会变得更加美丽。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/4f30d3fa2a1fec0deefaa0d1f76821dd.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/20231128b990e24960f9e9768c37a8cbdf5cc7e8.wav", "createTime": "2023-11-28T16:22:08", "modifyTime": null, "status": "FINISHED" }, { "id": 1574, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 4, "storyContext": "于是，小明开始了艰苦的任务，他用自己的双手和大脑，一步步地清理着每一个角落。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/17ed48a2e5523d314f8ff42d00579df1.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/20231128011eda8724cc0f212b5d767c573bc2cc.wav", "createTime": "2023-11-28T16:22:14", "modifyTime": null, "status": "FINISHED" }, { "id": 1575, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 5, "storyContext": "在这个过程中，小明不仅锻炼了自己的毅力和团队合作能力，还学会了如何运用科技手段来解决难题。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/93c11bc344f893f46b7b813c6520314a.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/20231128a3b680908ede8089fbaba9fd93a54ef7.wav", "createTime": "2023-11-28T16:22:18", "modifyTime": null, "status": "FINISHED" }, { "id": 1576, "userId": "6539cbedf1667d5c87d01369", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyDetailProcess": null, "storyId": 177, "storyPage": 6, "storyContext": "最终，他成功地完成了这次任务，让地球重新焕发生机。小明成为了一位受人尊敬的英雄，他的名字传遍了整个星球，甚至宇宙本身。", "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/a97f838640aca4652d84e9150cee6b0e.png", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/202311286b9c46ac9c863f9e8a8e58073c51a93d.wav", "createTime": "2023-11-28T16:22:23", "modifyTime": null, "status": "FINISHED" } ] } ## 3 查询故事列表 ### 接口 /tianshu/api/v1/storyList ### 类型 GET ### 参数无 ### 返回 userStory 列表 userStory 详细字段： | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | userId | String | 用户ID | | userName | String | 用户名 | | taskId | String | 任务ID | | storyTitle | String | 故事标题 | | storyCover | String | 故事封面 | | storyDescription | String | 故事描述 | | storyVideo | String | 视频URL | | storyProcess | String | 生成进度 | | advanceSetting | String | 高级设置，格式为JSON | | createTime | LocalDateTime | 创建日期 | | modifyTime | LocalDateTime | 修改日期 | | status | String | 故事状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | ### 示例 #### 请求 curl -H "Authorization: "\ http://api.mthreads.com/tianshu/v1/storyList #### 返回 [ { "id": 174, "userId": null, "userName": "开发者", "taskId": "7474b46d-0db0-4bf0-b1af-4cc47771bb37", "storyTitle": "宇宙探索", "storyCover": "https://mt-tianshu.tos-cn-beijing.volces.com/7474b46d-0db0-4bf0-b1af-4cc47771bb37/371621c7cf725dfc8e87b97ad6886dcb.png", "storyVideo": "https://mt-tianshu.tos-cn-beijing.volces.com/7474b46d-0db0-4bf0-b1af-4cc47771bb37/宇宙探索.mp4", "storyProcess": "100", "storyDescription": "小明是宇宙超人，在宇宙中探索", "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-23T16:49:55", "modifyTime": "2023-11-23T16:52:08", "status": "FINISHED", "delTag": 1 }, { "id": 177, "userId": null, "userName": "开发者", "taskId": "4457aea3-92db-4ab7-aefd-2cc2b0cb03ee", "storyTitle": "太空探索", "storyCover": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/3a2db207e13d2e62f00c441963379caa.png", "storyVideo": "https://mt-tianshu.tos-cn-beijing.volces.com/4457aea3-92db-4ab7-aefd-2cc2b0cb03ee/太空探索.mp4", "storyProcess": "100", "storyDescription": "小明是太空超人，在太空中遨游", "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-28T16:13:36", "modifyTime": "2023-11-28T16:21:52", "status": "FINISHED", "delTag": 1 } ] ## 4 分页查询故事列表 ### 接口 /tianshu/api/v1/storyListPage ### 类型 GET ### 参数 | 名称 | 类型 | 备注 | | --- | --- | --- | | page | Integer | 页码 | | pageSize | Integer | 每页条数 | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | current | Integer | 当前页码 | | pages | Integer | 总页数 | | records | userStory | 故事列表 | | size | Integer | 每页大小 | | total | Integer | 总条数 | ### 示例 #### 请求 curl -H "Authorization: "\ http://api.mthreads.com/tianshu/v1/storyListPage?page=1&pageSize=2 #### 返回 { "current": 1, "hitCount": false, "optimizeCountSql": true, "orders": [], "pages": 5, "records": [ { "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"SSB3001\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-14 18:31:58", "delTag": 1, "id": 143, "modifyTime": "2023-11-14 18:33:10", "status": "FINISHED", "storyCover": "/oss/tianshu/e1445b40-d5aa-4c28-a335-d47f65157797/9e6275b48ead3150f2dd06b30c1836a1.png", "storyDescription": "用龟兔赛跑写一篇故事，故事大纲为：乌龟和兔子相约跑步比赛->兔子一开始领先->兔子骄傲了->乌龟持之以恒，赢得胜利。", "storyProcess": "100", "storyTitle": "龟兔赛跑", "storyVideo": "/oss/tianshu/e1445b40-d5aa-4c28-a335-d47f65157797/2c7e23f53aa1ccd463502ae3377aba06.mp4", "taskId": "e1445b40-d5aa-4c28-a335-d47f65157797", "userName": "开发者" }, { "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"SSB3002\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-14 18:33:51", "delTag": 1, "id": 144, "modifyTime": "2023-11-14 18:35:00", "status": "FAILED", "storyCover": "/oss/tianshu/b134d1bb-d23f-4b05-9f70-cf4c69a14a7a/b0a023e0a2be92873b6761f068587649.png", "storyDescription": "用龟兔赛跑写一篇故事，故事大纲为：乌龟和兔子相约跑步比赛->兔子一开始领先->兔子骄傲了->乌龟持之以恒，赢得胜利。", "storyProcess": "50", "storyTitle": "龟兔赛跑", "taskId": "b134d1bb-d23f-4b05-9f70-cf4c69a14a7a", "userName": "开发者" } ], "searchCount": true, "size": 2, "total": 9 } ## 5 重新创建 ### 接口 /tianshu/api/v1/retryCreate ### 类型 GET ### 参数 * id 作品ID ### 返回 * 状态码: 200 OK | 名称 | 类型 | 备注 | | --- | --- | --- | | userStory | Object | 提交的故事数据 | * userStory 内容 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | userId | String | 用户ID | | userName | String | 用户名 | | taskId | String | 任务ID | | storyTitle | String | 故事标题 | | storyCover | String | 故事封面 | | storyDescription | String | 故事描述 | | storyVideo | String | 视频URL | | storyProcess | String | 生成进度 | | advanceSetting | String | 高级设置，格式为JSON | | createTime | LocalDateTime | 创建日期 | | modifyTime | LocalDateTime | 修改日期 | | status | String | 故事状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | ### 示例 #### 请求 curl -H "Authorization: "\ http://api.mthreads.com/tianshu/v1/retryCreate?id=177 #### 返回 { "userStory": { "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-11-28 16:13:36", "delTag": 1, "id": 177, "modifyTime": "2023-11-28 16:21:52", "status": "CREATED", "storyDescription": "小明是宇宙超人，在宇宙中探索", "storyProcess": "0", "storyTitle": "宇宙探索", "storyVideo": "", "taskId": "1e60f32f-dc41-4ce5-998a-ab07327b122a", "userId": "6539cbedf1667d5c87d01369", "userName": "开发者" } } ## 6 删除作品 ### 接口 /tianshu/api/v1/deleteStory ### 类型 GET ### 参数 `id` 故事作品ID ### 返回 * 状态码: 200 OK ### 示例 #### 请求 curl -H "Authorization: "\ http://api.mthreads.com/tianshu/v1/deleteStory?id=177 ## 7 修改作品标题 ### 接口 /tianshu/api/v1/updateStory ### 类型 POST ### 参数 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | storyTitle | String | 故事标题 | ### 返回 * 状态码: 200 OK ### 示例 #### 请求 curl --location --request GET 'http://tianshu-test.mthreads.com/tianshu/api/v1/updateStory' \ --header 'Content-Type: application/json' \ --header 'Authorization: ' \ --data '{ "storyTitle": "新的标题", "id":209 }' ## 8 分享作品 ### 接口 /tianshu/api/v1/shareStory ### 类型 GET ### 参数 `id` 故事作品ID ### 返回 * 状态码: 200 OK * 分享id 类型：String ### 示例 #### 请求 curl -H "Authorization: "\ http://api.mthreads.com/tianshu/v1/shareStory?id=177 #### 返回 57d40803-70b9-46ac-9e86-f00e2e2183fa ## 9 使用websocket创建作品 websocket 连接超过10秒没有读写会自动断开，可以发送PING 心跳，服务器会返回PONG。建立连接依旧需要在请求头设置token。 ### 接口 /tianshu/websocket/{token} 请将token换成请求头中携带的token。 ### 类型 websocket ### 参数 JSON格式 | 名称 | 类型 | 备注 | | --- | --- | --- | | requestId | String | 请求ID，随机不重复的ID | | method | String | 接口名，固定为 createStory | | data | Object | 创建接口所需参数，见下表 | data对象参数： | 名称 | 类型 | 备注 | | --- | --- | --- | | storyTitle | String | 故事标题，不超过10个字 | | storyDescription | String | 故事描述，不超过200字 | | dubbing | String | 配音，可选参数： 1 温柔女声： LYG1004 2 萌趣童声： babyx 3 活力童声： boyten | | bgm | String | 背景音乐： 1 春日郊游 BGM\_01.wav 2 探索发现 BGM\_02.wav 3 小侦探 BGM\_03.wav | | volume | String | 音量 1 - 72之间的参数 | | font | String | 字体： 1 抖音美好体 DouyinSansBold 2 阿里巴巴普惠体 Alibaba-PuHuiTi-Light 3 猫啃什锦体 MaokenAssortedSans 4 荆南麦圆体 jingnanmaiyuan 5 思源黑体 SourceHanSansCN-Light 6 思源宋体 SourceHanSerifCN-Light-5 7 字魂扁桃体 zihunbiantao | | fontSize | String | 字号 1-72 | | fontColor | String | 字体颜色，十六进制颜色码示例： #00FF00 | | backgroundColor | String | 背景色,十六进制颜色码示例： #FFFFFF | | videoRatio | String | 视频尺寸: 1:1 4:3 3:4 | | videoResolution | String | 视频清晰度: 标清： SD 高清： HD | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | requestId | String | 请求ID，对应传入的请求ID | | statusCode | Integer | 状态码，1000为成功，其他为失败 | | message | String | 返回信息，错误信息或成功标识 | | resultType | String | 目前有三种情况： null:无数据返回 USER\_STORY：表示返回数据为故事主体 USER\_STORY\_DETAIL：表示返回数据为故事的一段 | | data | Object | 返回数据 | USER\_STORY的data： | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | userId | String | 用户ID | | userName | String | 用户名 | | taskId | String | 任务ID | | storyTitle | String | 故事标题 | | storyCover | String | 故事封面，非单独生成的图片，一般取详情列表的第一张图片做封面 | | storyDescription | String | 故事描述 | | storyVideo | String | 视频URL | | storyProcess | String | 生成进度 | | advanceSetting | String | 高级设置，格式为JSON | | createTime | LocalDateTime | 创建日期 | | modifyTime | LocalDateTime | 修改日期 | | status | String | 故事状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | USER\_STORY\_DETAIL的data: | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | ID | | userId | String | 用户ID | | taskId | String | 任务ID | | storyId | Long | 故事ID | | storyPage | Integer | 页码 | | storyContext | String | 故事正文 | | storyImage | String | 图片地址 | | storyAudio | String | 故事单句语音 | | createTime | LocalDateTime | 创建时间 | | modifyTime | LocalDateTime | 修改时间 | | status | String | 生成状态： CREATED ：生成中 FINISHED ：生成完成 FAILED ：生成失败 | ### 示例请求： { "requestId":"c60e4f4e-607f-545c-209c-ed132d3239f9", "method":"createStory", "data":{ "storyDescription":"小明是宇宙超人，在宇宙中探索", "storyTitle":"宇宙探索", "backgroundColor":"#FFFFFF", "bgm":"BGM_03.wav", "dubbing":"LYG1004", "font":"MaokenAssortedSans", "fontColor":"#000000", "fontSize":"14", "videoDuration":"short", "videoRatio":"1:1", "videoResolution":"SD", "volume":"30" } } 返回： { "message": "success", "requestId": "c60e4f4e-607f-5d5c-209c-ed132d3239f9", "result": { "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-12-07 17:03:12.127", "delTag": 1, "id": 1, "requestId": "c60e4f4e-607f-5d5c-209c-ed132d3239f9", "status": "CREATED", "storyDescription": "小明是宇宙超人，在宇宙中探索", "storyProcess": "0", "storyTitle": "宇宙探索", "taskId": "662f7c25-fc9a-43dc-8fb2-a9080def8ecc", "userId": "6539cbedf1667d5c87d01369", "userName": "开发者" }, "resultType": "USER_STORY", "statusCode": 1000 } 首次返回resultType为 USER\_STORY 的数据，并且"status"为 "CREATED"，代表开始创建 { "message": "success", "requestId": "c60e4f4e-607f-5d5c-209c-ed132d3239f9", "result": { "createTime": "2023-12-07 17:03:20", "id": 20, "modifyTime": "2023-12-07 17:04:20.019", "status": "FINISHED", "storyAudio": "https://mt-tianshu.tos-cn-beijing.volces.com/662f7c25-fc9a-43dc-8fb2-a9080def8ecc/20231207be6dcba8d7d12aed4dd0d420b45cd680.wav", "storyContext": "在遥远的未来，有一个小男孩名叫小明。他是一位聪明勇敢的少年，他的家乡正面临着一场空前的大灾难——太空垃圾污染。", "storyId": 1, "storyImage": "https://mt-tianshu.tos-cn-beijing.volces.com/662f7c25-fc9a-43dc-8fb2-a9080def8ecc/23c8dc785577f4514202e05b2e67e7bb.png", "storyPage": 0, "taskId": "662f7c25-fc9a-43dc-8fb2-a9080def8ecc", "userId": "6539cbedf1667d5c87d01369" }, "resultType": "USER_STORY_DETAIL", "statusCode": 1000 } 过程中会持续返回"resultType"为"USER\_STORY\_DETAIL"的每段故事，可以根据storyPage进行页码排序 { "message": "success", "requestId": "c60e4f4e-607f-5d5c-209c-ed132d3239f9", "result": { "advanceSetting": "{\"backgroundColor\":\"#FFFFFF\",\"bgm\":\"BGM_03.wav\",\"dubbing\":\"LYG1004\",\"font\":\"MaokenAssortedSans\",\"fontColor\":\"#000000\",\"fontSize\":\"14\",\"videoDuration\":\"short\",\"videoRatio\":\"1:1\",\"videoResolution\":\"SD\",\"volume\":\"30\"}", "createTime": "2023-12-07 17:03:12", "delTag": 1, "id": 1, "modifyTime": "2023-12-07 17:04:30", "requestId": "c60e4f4e-607f-5d5c-209c-ed132d3239f9", "status": "FINISHED", "storyDescription": "小明是宇宙超人，在宇宙中探索", "storyProcess": "100", "storyTitle": "宇宙探索", "storyVideo": "https://mt-tianshu.tos-cn-beijing.volces.com/662f7c25-fc9a-43dc-8fb2-a9080def8ecc/宇宙探索.mp4", "taskId": "662f7c25-fc9a-43dc-8fb2-a9080def8ecc", "userId": "6539cbedf1667d5c87d01369", "userName": "开发者" }, "resultType": "USER_STORY", "statusCode": 1000 } 结束后再次返回"resultType"为"USER\_STORY"的数据，并附"status" ，如果失败则为FAILED，成功则为FINISHED ## 10 根据文字生成图片 ### 接口 /tianshu/api/v1/createImages ### 类型 POST ### 参数 JSON格式 | 名称 | 类型 | 备注 | | --- | --- | --- | | ratio | String | 图片比例： 1:1 4:3 3:4 | | prompt | String | 生成语句 | | resolution | String | 清晰度: SD HD | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | task\_id | String | 任务ID | | queue\_count | Integer | 排队任务数量 | ### 示例请求： { "ratio":"1:1", "prompt":"男孩，汽车", "resolution":"SD" } 返回 { "status": 0, "message": "success", "data": { "task_id": "7ee287ff-61a7-4a7d-b74d-28f7a1c9bf69", "queue_count": 0 } } ## 12 重绘图片 ### 接口 /tianshu/api/v1/createImage ### 类型 POST ### 参数 JSON格式 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Long | 故事ID | | context | String | 修改后的文本 | | previousContext | String\[\] | 所修改图片之前的文本数组。 | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | task\_id | String | 任务ID | | queue\_count | Integer | 排队任务数量 | ### 示例请求： { "ratio":"1:1", "prompt":"男孩，汽车", "resolution":"SD" } 返回 { "status": 0, "message": "success", "data": { "task_id": "7ee287ff-61a7-4a7d-b74d-28f7a1c9bf69", "queue_count": 0 } } ## 13 获取图片 ### 接口 /tianshu/api/v1/getImage ### 类型 GET ### 参数 JSON格式 | 名称 | 类型 | 备注 | | --- | --- | --- | | taskId | String | 任务ID | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | id | Integer | 图片生成编号 | | createTime | String | 生成时间 | | context | String | 输入文字 | | imagePath | String | 图片路径 | | status | String | 任务状态： CREATED ：生成中 SUCCESS ：成功 FAILED ：失败 | | taskId | String | 任务ID | ### 示例请求： http://api.mthreads.com/tianshu/api/v1/getImage?taskId=7ee287ff-61a7-4a7d-b74d-28f7a1c9bf69 返回 { "context": "男孩，汽车", "createTime": "2023-12-19 21:11:35", "id": 2, "imagePath": "[\"https://mt-tianshu.tos-cn-beijing.volces.com/7ee287ff-61a7-4a7d-b74d-28f7a1c9bf69/1d583c10824bf0c369f15970548c67fd.png\"]", "status": "SUCCESS", "taskId": "7ee287ff-61a7-4a7d-b74d-28f7a1c9bf69", "userId": "qM27O4ZwiFa0LS1Lib9lQ2MToZTKh0pwEFJ52R28rcBiSK6y8CCUEH8BMti0KIzz" } # 天书绘图 ## 1.请求接口 [](http://maliang-saas.10.11.8.214.nip.io:35238/maliang/portrait/submit)http://api.mthreads.com[/maliang/tianshu-draw/submit](http://maliang-saas.10.11.8.214.nip.io:35238/maliang/portrait/submit) ### 类型 POST ### 参数 JSON格式 | 名称 | 类型 | 备注 | | --- | --- | --- | | ratio | String | 图片比例（宽高）： 1:1 4:3 3:4 | | text\_opt | String | 生成语句 | | resolution | String | 清晰度: SD HD | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | task\_id | String | 任务ID | | queue\_count | Integer | 排队任务数量 | ### 示例请求： curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: "\ -d '{"text_opt": "狂风暴雨", "ratio": "3:4", "resolution": "HD"}'\ http://api.mthreads.com/maliang/tianshu-draw/submit 返回 { "status": 0, "message": "success", "data": { "task_id": "78915552-4aee-48aa-bad0-0ebb787216fd", "queue_count": 0 } } ## 2.查询任务 ### 测试接口 [](http://maliang-saas-dev.10.10.1.3.nip.io:30724/maliang/base/state/6d7980f0-ebe6-4f32-bd70-49661cf31788)http://api.mthreads.com[/maliang/tianshu-d/state/](http://maliang-saas-dev.10.10.1.3.nip.io:30724/maliang/base/state/6d7980f0-ebe6-4f32-bd70-49661cf31788){task\_id} ### 类型 Get ### 参数 | 名称 | 类型 | 备注 | | --- | --- | --- | | task\_id | string | 任务id | ### 返回 | 名称 | 类型 | 备注 | | --- | --- | --- | | status | int | 状态。0 成功，其他失败 | | message | string | 信息。“success”成功 | | data | json object | | | data.task\_id | string | 任务ID | | data.state | string | 任务状态 PENDING。等待中 STARTED。开始 PROGRESS。进行中 RETRY。重试 FAILURE。失败 SUCCESS。成功 | | data.image | string list | 图片名称 | ### 示例 #### 请求 curl -H "Authorization: "\ http://api.mthreads.com/maliang/tianshu-draw/state/78915552-4aee-48aa-bad0-0ebb787216fd #### 返回 { "status": 0, "message": "success", "data": { "task_id": "78915552-4aee-48aa-bad0-0ebb787216fd", "state": "SUCCESS", "image": [ "tianshu_7edbba0b548b9bbe90781c2d63933a41.png" ] } } ## 3.下载图片 ### 类型 Get ### 参数 | 名称 | 类型 | 备注 | | --- | --- | --- | | image\_name | string | 图片的image name | ### 接口: ### 3.1 TOS火山云下载： [https://mt-tianshu.tos-cn-beijing.volces.com/](https://mt-tianshu.tos-cn-beijing.volces.com/7ee287ff-61a7-4a7d-b74d-28f7a1c9bf69/1d583c10824bf0c369f15970548c67fd.png){image\_name} #### 示例 https://mt-tianshu.tos-cn-beijing.volces.com/tianshu_614812f1be5061421bd6476e57a54e3a.png ### 3.2 私有Ceph下载： [](http://maliang-saas-dev.10.10.1.3.nip.io:30724/image/images/)http://api.mthreads.com[/image/images/](http://maliang-saas-dev.10.10.1.3.nip.io:30724/image/images/){image\_name} #### 示例 curl -H "Authorization: "\ http://api.mthreads.com/image/images/tianshu_7edbba0b548b9bbe90781c2d63933a41.png

摩笔天书在线API服务

在线手册