> ## Documentation Index > Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt > Use this file to discover all available pages before exploring further. # Sora Tasks API 的对接和使用 > Sora Video Generation 集成指南 - XHuoAPI Sora Tasks API 的主要功能是通过输入 Sora Videos Generation API 生成的任务ID来查询该任务的执行情况。 本文档将详细介绍 Sora Tasks API 的对接说明，帮助您轻松集成并充分利用该 API 的强大功能。通过 Sora Tasks API ，您可以轻松实现查询 Sora Videos Generation API 的任务执行情况。 ## 申请流程 要使用 Sora Tasks API，需要先到 申请页面 [Sora Videos Generation API ](https://api.xhuoapi.ai/documents/99a24421-2e22-4028-8201-e19cb834b67e)申请相应的服务，然后复制 Sora Videos Generation API的任务ID，如图所示：

最后进入Tasks API页面 [Sora Tasks API ](https://api.xhuoapi.ai/documents/c9d81bad-9064-4796-86b6-4fb43cc93a16)申请相应的服务，进入页面之后，点击「Acquire」按钮，如图所示： ![申请页面](https://cdn.xhuoapi.ai/rci31i.png) 如果您尚未登录或注册，会自动跳转到[登录页面](https://api.xhuoapi.ai)邀请您来注册和登录，登录注册之后会自动返回当前页面。 首次申请时会有免费额度赠送，可以免费使用该 API。 ## 请求示例 Sora Tasks API 可以用于查询 Sora Videos Generation API 的结果。关于怎样使用 Sora Videos Generation API，请参考文档 [Sora Videos Generation API ](https://api.xhuoapi.ai/documents/sora-videos-integration)。 我们以 Sora Videos Generation API 服务返回的任务ID一个为例，演示如何使用该 API。假设我们有一个任务ID：b8976e18-32dc-4718-9ed8-1ea090fcb6ea，接下来演示如何通过传入一个任务ID来。 ### 任务示例图

### 设置请求头和请求体 **Request Headers** 包括： * `accept`：指定接收 JSON 格式的响应结果，这里填写为 `application/json`。 * `authorization`：调用 API 的密钥，申请之后可以直接下拉选择。 **Request Body** 包括： * `id`：上传的任务ID。 * `action`：对任务的操作方式。 设置如下图所示：

### 代码示例 可以发现，在页面右侧已经自动生成了各种语言的代码，如图所示：

部分代码示例如下： #### CURL ```bash theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/sora/tasks' \ -H 'accept: application/json' \ -H 'authorization: Bearer {token}' \ -H 'content-type: application/json' \ -d '{ "id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "action": "retrieve" }' ``` #### Python ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/sora/tasks" headers = { "accept": "application/json", "authorization": "Bearer {token}", "content-type": "application/json" } payload = { "id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "action": "retrieve" } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ### 响应示例 请求成功后，API 将返回此处视频任务的详情信息。例如： ```json theme={null} { "_id": "68e914aa550a4144a5788305", "id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "api_id": "54aed96c-0346-4227-8c99-9780247a7ffd", "application_id": "f10c04c2-2273-4463-bd3f-593d71b75ac8", "created_at": 1760105642.045, "credential_id": "4e6e181d-f320-4874-8d80-fc2253b40b7e", "request": { "size": "large", "duration": 15, "orientation": "landscape", "prompt": "cat running on the river", "model": "sora-2", "image_urls": [ "https://cdn.xhuoapi.ai/11wfp4.png" ], "callback_url": "https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa" }, "trace_id": "fb751e1e-4705-49ea-9fd4-5024b7865ea2", "type": "videos", "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf", "response": { "success": true, "task_id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "trace_id": "fb751e1e-4705-49ea-9fd4-5024b7865ea2", "data": [ { "id": "sora-2:task_01k777hjrbfrgs2060q5zvf2a5", "video_url": "https://filesystem.site/gptimage/vg-assets/assets%2Ftask_01k777hjrbfrgs2060q5zvf2a5%2Ftask_01k777hjrbfrgs2060q5zvf2a5_genid_b8e2e5d1-a579-49ca-a21c-cb3869685cce_25_10_10_14_15_147334%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-10T12%3A38%3A49Z&se=2025-10-16T13%3A38%3A49Z&sks=b&skt=2025-10-10T12%3A38%3A49Z&ske=2025-10-16T13%3A38%3A49Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=aa5ddad1-c91a-4f0a-9aca-e20682cc8969&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=p4aMqXqkP%2FI1IhOVGCB9JL8vUUvfNBBF12ESpKhKXOk%3D&az=oaivgprodscus", "state": "succeeded" } ] } } ``` 返回结果一共有多个字段，request 字段就是发起任务时的 request body，同时response 字段是任务完成后返回的response body。字段介绍如下。 * `id`，生成此视频任务的 ID，用于唯一标识此次视频生成任务。 * `request`，查询视频任务中的请求信息。 * `response`，查询视频任务中的返回信息。 ## 批量查询操作 这是是针对多个任务ID来进行查询视频任务详情，与上面不同的是需要将action选中为retrieve\_batch **Request Body** 包括： * `ids`：上传的任务ID数组。 * `action`：对任务的操作方式。 设置如下图所示：

### 代码示例 可以发现，在页面右侧已经自动生成了各种语言的代码，如图所示：

部分代码示例如下： #### CURL ```bash theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/sora/tasks' \ -H 'accept: application/json' \ -H 'authorization: Bearer {token}' \ -H 'content-type: application/json' \ -d '{ "ids": ["b8976e18-32dc-4718-9ed8-1ea090fcb6ea","b8976e18-32dc-4718-9ed8-1ea090fcb6ea"], "action": "retrieve_batch" }' ``` #### Python ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/sora/tasks" headers = { "accept": "application/json", "authorization": "Bearer {token}", "content-type": "application/json" } payload = { "ids": ["b8976e18-32dc-4718-9ed8-1ea090fcb6ea","b8976e18-32dc-4718-9ed8-1ea090fcb6ea"], "action": "retrieve_batch" } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ### 响应示例 请求成功后，API 将返回此次所有批量视频任务的具体详情信息。例如： ```json theme={null} { "items": [ { "_id": "68e914aa550a4144a5788305", "id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "api_id": "54aed96c-0346-4227-8c99-9780247a7ffd", "application_id": "f10c04c2-2273-4463-bd3f-593d71b75ac8", "created_at": 1760105642.045, "credential_id": "4e6e181d-f320-4874-8d80-fc2253b40b7e", "request": { "size": "large", "duration": 15, "orientation": "landscape", "prompt": "cat running on the river", "model": "sora-2", "image_urls": [ "https://cdn.xhuoapi.ai/11wfp4.png" ], "callback_url": "https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa" }, "trace_id": "fb751e1e-4705-49ea-9fd4-5024b7865ea2", "type": "videos", "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf", "response": { "success": true, "task_id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "trace_id": "fb751e1e-4705-49ea-9fd4-5024b7865ea2", "data": [ { "id": "sora-2:task_01k777hjrbfrgs2060q5zvf2a5", "video_url": "https://filesystem.site/gptimage/vg-assets/assets%2Ftask_01k777hjrbfrgs2060q5zvf2a5%2Ftask_01k777hjrbfrgs2060q5zvf2a5_genid_b8e2e5d1-a579-49ca-a21c-cb3869685cce_25_10_10_14_15_147334%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-10T12%3A38%3A49Z&se=2025-10-16T13%3A38%3A49Z&sks=b&skt=2025-10-10T12%3A38%3A49Z&ske=2025-10-16T13%3A38%3A49Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=aa5ddad1-c91a-4f0a-9aca-e20682cc8969&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=p4aMqXqkP%2FI1IhOVGCB9JL8vUUvfNBBF12ESpKhKXOk%3D&az=oaivgprodscus", "state": "succeeded" } ] } }, { "_id": "68e914aa550a4144a5788305", "id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "api_id": "54aed96c-0346-4227-8c99-9780247a7ffd", "application_id": "f10c04c2-2273-4463-bd3f-593d71b75ac8", "created_at": 1760105642.045, "credential_id": "4e6e181d-f320-4874-8d80-fc2253b40b7e", "request": { "size": "large", "duration": 15, "orientation": "landscape", "prompt": "cat running on the river", "model": "sora-2", "image_urls": [ "https://cdn.xhuoapi.ai/11wfp4.png" ], "callback_url": "https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa" }, "trace_id": "fb751e1e-4705-49ea-9fd4-5024b7865ea2", "type": "videos", "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf", "response": { "success": true, "task_id": "b8976e18-32dc-4718-9ed8-1ea090fcb6ea", "trace_id": "fb751e1e-4705-49ea-9fd4-5024b7865ea2", "data": [ { "id": "sora-2:task_01k777hjrbfrgs2060q5zvf2a5", "video_url": "https://filesystem.site/gptimage/vg-assets/assets%2Ftask_01k777hjrbfrgs2060q5zvf2a5%2Ftask_01k777hjrbfrgs2060q5zvf2a5_genid_b8e2e5d1-a579-49ca-a21c-cb3869685cce_25_10_10_14_15_147334%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-10T12%3A38%3A49Z&se=2025-10-16T13%3A38%3A49Z&sks=b&skt=2025-10-10T12%3A38%3A49Z&ske=2025-10-16T13%3A38%3A49Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=aa5ddad1-c91a-4f0a-9aca-e20682cc8969&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=p4aMqXqkP%2FI1IhOVGCB9JL8vUUvfNBBF12ESpKhKXOk%3D&az=oaivgprodscus", "state": "succeeded" } ] } } ], "count": 2 } ``` 返回结果一共有多个字段，其中items是包含了批量视频任务的具体详情信息，每个视频任务的具体信息与上文的字段一样，字段信息如下。 * `items`，批量视频任务的所有具体详情信息。它是一个数组，每个数组的元素和上文查询单个任务的返回结果格式是一样的。 * `count`，此处批量查询视频任务的个数。 ## 错误处理 在调用 API 时，如果遇到错误，API 会返回相应的错误代码和信息。例如： * `400 token_mismatched`：Bad request, possibly due to missing or invalid parameters. * `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters. * `401 invalid_token`：Unauthorized, invalid or missing authorization token. * `429 too_many_requests`：Too many requests, you have exceeded the rate limit. * `500 api_error`：Internal server error, something went wrong on the server. ### 错误响应示例 ```json theme={null} { "success": false, "error": { "code": "api_error", "message": "fetch failed" }, "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89" } ``` ## 结论 通过本文档，您已经了解了如何使用 Sora Tasks API 进行查询单个或批量视频任务的所有具体详情信息。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。