AiSearchJobCancel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-ai-search-job-cancel-schema.json",
  "title": "AiSearchJobCancel",
  "description": "Body for `DELETE /projects/ai-search/jobs/{id}`: the job's state after the cancellation request was applied.",
  "x-generated": "2026-11-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/boardwalkai-com-openapi.yml#/components/schemas/AiSearchJobCancel",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "integer"
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "completed",
        "partial",
        "failed",
        "cancelled",
        "expired"
      ]
    },
    "cancelRequested": {
      "type": "boolean",
      "description": "True once a cancel has been recorded; the worker honours it at the next batch boundary."
    },
    "creditsReserved": {
      "type": "integer"
    },
    "creditsCharged": {
      "type": [
        "integer",
        "null"
      ]
    },
    "creditsRefunded": {
      "type": "integer",
      "description": "Credits refunded by THIS request. A queued job refunds its full reservation here; a running job refunds nothing yet; its settlement true-up refunds the unused remainder."
    },
    "pollUrl": {
      "type": "string"
    }
  }
}