Tasks

Cancel a task

Cancel a task. Refunds the full charge if it has not started; no refund once the provider has been billed (status=processing). Returns 409 if the task already reached a terminal status.

delete/v1/tasks/{id}

Request

  • Base URL: https://api.hotapi.ai
  • URL: https://api.hotapi.ai/v1/tasks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Confirmation that a task was cancelled.

idstring required
status'cancelled' required

Example response

{
  "id": "task_8sd9f7aQ2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.