Cancel a queued or generating article and get its prepaid unit back. Generation stops at its next step. Idempotent: repeating it answers 200 with already_canceled and refunds nothing. A finished or failed article answers 409 and nothing is refunded (a failed article was already refunded).

post/articles/{articleId}/cancel

Request

  • Base URL: https://app.seomatic.ai/api/v1
  • URL: https://app.seomatic.ai/api/v1/articles/{articleId}/cancel
  • Auth: HTTP bearer

Path parameters

articleIdstring uuid required

Response

{ id, status: "canceled", refunded } (plus already_canceled: true on a repeat, with refunded: false)

Changes

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