Docs
Api referenceExports

Cancel export task

DELETE
/v1/exports/{taskId}

Cancel a pending, processing, or paused export task. Repeating cancellation for an already canceled task succeeds. Only Open API exports visible through the task detail endpoint can be canceled. Completed or failed tasks return 409 TASK_NOT_CANCELABLE. Cancellation prevents the result from being published; it does not guarantee that rendering stops immediately. Use the returned task or poll its detail to observe cancellation. No cancellation webhook is sent.

Authorization

BearerAuth
AuthorizationBearer <token>

Send an existing generated API key as Authorization: Bearer sk_indream_.... OAuth access tokens are not accepted by the Open API. Enter the API key manually in the interactive docs playground. The value is stored only in the current browser and is not injected from server environment variables.

In: header

Path Parameters

taskId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.indream.ai/v1/exports/string"
{
  "data": {
    "taskId": "string",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "createdByApiKeyId": "string",
    "clientTaskId": "string",
    "status": "PENDING",
    "progress": 0,
    "exportPhase": "rendering",
    "error": "string",
    "outputUrl": "string",
    "filename": "string",
    "durationSeconds": 0,
    "billedStandardSeconds": 0,
    "chargedCredits": "string",
    "callbackUrl": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {}
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}
{
  "type": "FORBIDDEN",
  "title": "Forbidden",
  "status": 403,
  "detail": "The current account is not eligible for this Open API route",
  "errorCode": "OPEN_API_RUNTIME_ACCESS_FORBIDDEN"
}