DELETE
/v1/3d/tasks/:taskIdFree · 0 creditsCancel Task
Stop a task that is still PENDING or IN_PROGRESS. Its credits are refunded automatically. Cancelling a task that has already finished changes nothing and returns its current status.
AuthenticationAuthorization: Bearer hyd_live_your_api_key_here
Base URLhttps://backend.hydrilla.ai
Overview
Stop a task that is still PENDING or IN_PROGRESS. Its credits are refunded automatically. Cancelling a task that has already finished changes nothing and returns its current status.
Request body
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| taskId# | string | required | — | The job identifier returned by /v1/3d/text-to-3d or /v1/3d/image-to-3d. |
taskIdrequired
string
The job identifier returned by /v1/3d/text-to-3d or /v1/3d/image-to-3d.
Response
Successful requests return the job object. Errors use the status codes below.
Authentication errors
401 — Invalid or revoked API key. 402 — Not enough credits.
curl -X DELETE https://backend.hydrilla.ai/v1/3d/tasks/job_9b1deb4d3b7d4e8b82 \
-H "Authorization: Bearer hyd_live_your_api_key_here"import requests
headers = {"Authorization": "Bearer hyd_live_your_api_key_here"}
res = requests.delete("https://backend.hydrilla.ai/v1/3d/tasks/job_9b1deb4d3b7d4e8b82", headers=headers).json()
print(res["status"]) # CANCELLEDconst res = await fetch("https://backend.hydrilla.ai/v1/3d/tasks/job_9b1deb4d3b7d4e8b82", {
method: "DELETE",
headers: { "Authorization": "Bearer hyd_live_your_api_key_here" },
});
console.log((await res.json()).status); // CANCELLED{
"id": "job_9b1deb4d3b7d4e8b82",
"object": "task",
"status": "CANCELLED"
}Response fields
- id string
- object string
- status string
{
"error": {
"message": "Invalid API key.",
"type": "authentication_error"
}
}