Skip to content

Query Task API ​

API Overview ​

Used to query the current status and result of a 3D model split task by task ID.

ProtocolEndpointMethodAuthRequest FormatResponse Format
HTTP/open-api/v1/split/query-taskGETTokenapplication/jsonapplication/json

Request Headers ​

ParameterValueDescription
Content-Typeapplication/jsonData exchange format
AuthorizationTokenReplace {token} with the token you obtained

Request Parameters (HTTP GET) ​

ParameterTypeRequiredDescription
task_idstringYesTask ID returned by the create-task API result
text
https://api.hitem3d.ai/open-api/v1/split/query-task?task_id=split_20260312_8f92ab3e1cde

Response Body ​

ParameterFieldTypeDescription
code-intError code, see error code table
datatask_idstringTask ID
statestringProcessing status
• created: task created
• queueing: task queued
• processing: task in progress
• success: task completed
• failed: task failed
idstringGenerated artifact ID
cover_urlstringGenerated cover image URL, valid for one hour
urlstringGenerated split result URL, valid for one hour. For character split with joints, this field returns the joint result URL when available
msg-stringDetailed error message
json
{
  "code": 200,
  "data": {
    "task_id": "split_20260312_8f92ab3e1cde",
    "state": "success",
    "id": "split_20260312_8f92ab3e1cde_0",
    "cover_url": "https://example.com/cover.png",
    "url": "https://example.com/split/output/result.glb"
  },
  "msg": "success"
}

Error Codes ​

Error codes are returned in JSON structure, including code and msg.

json
{
  "code": 5001001,
  "data": {},
  "msg": "generate failed"
}
Error CodeError MessageError Description
5001001generate failedTimeout or model parsing failed. Retry later; credits are refunded

Request Example (Shell) ​

shell
curl --location --request GET 'https://api.hitem3d.ai/open-api/v1/split/query-task?task_id=split_20260312_8f92ab3e1cde' \
--header 'Authorization: Token {{token}}' \
--header 'Content-Type: application/json'