> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sqwish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel prompt-tuning job

> Request cancellation of a prompt-tuning job. Running work may stop asynchronously.



## OpenAPI

````yaml /openapi.json post /v1/prompt-tuning/jobs/{job_id}/cancel
openapi: 3.1.0
info:
  title: DecisionOne workbench
  description: >-
    Native decisions, immutable datasets, adaptation and shared-base deployment.
    Authenticate with `Authorization: Bearer d1_sk_...` when accounts are on. A
    short guide for coding agents is at /llms.txt. Hosted account APIs accept a
    Bearer API key or a browser session. Browser mutations require the
    configured Origin and X-CSRF-Token from /auth/session. Account recovery and
    history remain available to blocked accounts. Waitlisted accounts can read
    their account summary and model catalogue and request early access; private
    member APIs require admission. Money fields ending in _usd are exact decimal
    strings; never interpret them as integer cents. Authenticated customer reads
    and existing-operation replays share read_rpm. Exhausted budgets return 429
    with Retry-After; unavailable admission storage returns 503.
  version: 0.1.0
servers:
  - url: https://console.sqwish.ai
security: []
tags:
  - name: Decisions
    description: Probabilities for questions with fixed outcomes.
  - name: Feedback
    description: Report outcomes and turn them into training data.
  - name: Models
    description: Base models, adapters and named models with versions.
  - name: Datasets
    description: Validated training examples. A dataset never changes.
  - name: Fine-tuning
    description: Training jobs, their events and held-out results.
  - name: Prompt tuning
    description: Better wording for a decision, tested on your rows. Words, not weights.
  - name: Labeling
    description: Teacher labels for real queries, reviewed by you.
  - name: Accounts
    description: Email OTP sign-in, revocable sessions, security and API keys.
  - name: Billing
    description: Exact USD balances, purchases, automatic top-ups and referrals.
  - name: Integrations
    description: Endpoints other tools call, such as Claude Code.
  - name: System
    description: Health and discovery.
paths:
  /v1/prompt-tuning/jobs/{job_id}/cancel:
    post:
      tags:
        - Prompt tuning
      summary: Cancel prompt-tuning job
      description: >-
        Request cancellation of a prompt-tuning job. Running work may stop
        asynchronously.
      operationId: cancelPromptTuningJob
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: string
                    title: Id
                  object:
                    type: string
                    const: prompt_tuning.job
                    title: Object
                  status:
                    type: string
                    enum:
                      - queued
                      - running
                      - cancelling
                      - succeeded
                      - failed
                      - cancelled
                    title: Status
                  dataset_id:
                    type: string
                    title: Dataset Id
                  model:
                    type: string
                    title: Model
                  decision:
                    type: string
                    title: Decision
                  wording_variants:
                    type: integer
                    title: Wording Variants
                  effort:
                    type: string
                    enum:
                      - standard
                      - thorough
                    title: Effort
                  price_cents:
                    type: integer
                    title: Price Cents
                  refunded:
                    type: boolean
                    title: Refunded
                  test_looks:
                    type: integer
                    title: Test Looks
                  progress:
                    anyOf:
                      - $ref: '#/components/schemas/PromptProgress'
                      - type: 'null'
                  result:
                    anyOf:
                      - $ref: '#/components/schemas/PromptResult'
                      - type: 'null'
                  created_at:
                    type: number
                    title: Created At
                  updated_at:
                    type: number
                    title: Updated At
                  error:
                    type: string
                    title: Error
                type: object
                required:
                  - id
                  - object
                  - status
                  - dataset_id
                  - model
                  - decision
                  - wording_variants
                  - effort
                  - price_cents
                  - refunded
                  - test_looks
                  - progress
                  - result
                  - created_at
                  - updated_at
                title: PromptTuningJob
        4XX:
          description: >-
            Client error. On a 422, `error.details` lists each field that
            failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        5XX:
          description: Server error. A 503 names what is not running on this server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PromptProgress:
      properties:
        phase:
          type: string
          title: Phase
        round:
          type: integer
          title: Round
        rounds:
          type: integer
          title: Rounds
        original_loss:
          type: number
          title: Original Loss
        best_loss:
          type: number
          title: Best Loss
        candidates:
          type: integer
          title: Candidates
      type: object
      title: PromptProgress
    PromptResult:
      properties:
        verdict:
          type: string
          enum:
            - improved
            - inconclusive
            - no_improvement
          title: Verdict
        reasons:
          items:
            type: string
          type: array
          title: Reasons
        tuned:
          anyOf:
            - $ref: '#/components/schemas/Decision'
            - type: 'null'
        candidate:
          anyOf:
            - $ref: '#/components/schemas/Decision'
            - type: 'null'
        changes:
          items:
            $ref: '#/components/schemas/PromptChange'
          type: array
          title: Changes
        test:
          additionalProperties: true
          type: object
          title: Test
        label_issues:
          items:
            $ref: '#/components/schemas/LabelIssue'
          type: array
          title: Label Issues
        cost:
          additionalProperties: true
          type: object
          title: Cost
        original:
          $ref: '#/components/schemas/Decision'
        decision:
          type: string
          title: Decision
        rows:
          type: integer
          title: Rows
        rows_left_out:
          type: integer
          title: Rows Left Out
        noise_band:
          type: number
          title: Noise Band
        candidates:
          type: integer
          title: Candidates
        rounds:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Rounds
        history:
          items:
            additionalProperties: true
            type: object
          type: array
          title: History
        reflections:
          type: integer
          title: Reflections
        skipped_reflections:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Skipped Reflections
        row_scorings:
          type: integer
          title: Row Scorings
      type: object
      required:
        - verdict
        - tuned
        - candidate
        - changes
        - label_issues
        - original
        - decision
        - rows
        - rows_left_out
        - noise_band
        - candidates
        - rounds
        - history
        - reflections
        - skipped_reflections
        - row_scorings
      title: PromptResult
    ErrorResponse:
      description: >-
        The body of every error. app.failure() builds it; this model documents
        it.
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
        - error
      title: ErrorResponse
      type: object
    Decision:
      properties:
        id:
          type: string
          maxLength: 128
          minLength: 1
          title: Id
        question:
          anyOf:
            - type: string
            - additionalProperties: true
              type: object
            - items: {}
              type: array
          title: Question
        kind:
          type: string
          enum:
            - single
            - binary
            - ordinal
          title: Kind
          default: single
        outcomes:
          title: Outcomes
        rubric:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Rubric
        weights:
          anyOf:
            - additionalProperties:
                type: number
              type: object
            - type: 'null'
          title: Weights
        costs:
          anyOf:
            - additionalProperties:
                additionalProperties:
                  type: number
                type: object
              type: object
            - type: 'null'
          title: Costs
        abstain:
          anyOf:
            - $ref: '#/components/schemas/Abstain'
            - type: 'null'
      additionalProperties: false
      type: object
      required:
        - id
        - question
      title: Decision
    PromptChange:
      properties:
        part:
          type: string
          title: Part
        before:
          type: string
          title: Before
        after:
          type: string
          title: After
      type: object
      required:
        - part
        - before
        - after
      title: PromptChange
    LabelIssue:
      properties:
        row:
          type: integer
          title: Row
        reason:
          type: string
          title: Reason
      type: object
      required:
        - row
        - reason
      title: LabelIssue
    ErrorBody:
      properties:
        code:
          description: A stable code to branch on, such as invalid_request.
          title: Code
          type: string
        message:
          description: What went wrong and what to change, in plain words.
          title: Message
          type: string
        retryable:
          description: >-
            True when another attempt may succeed; it does not prove that no
            work was done. Respect Retry-After when present. Only operations
            that support Idempotency-Key replay a prior result, including
            /v1/decide for 24 hours.
          title: Retryable
          type: boolean
        request_id:
          description: Also sent as X-Request-ID. Quote it in bug reports.
          title: Request Id
          type: string
        details:
          anyOf:
            - items:
                $ref: '#/components/schemas/ErrorDetail'
              type: array
            - type: 'null'
          default: null
          description: On validation errors, one entry for each field that failed.
          title: Details
      required:
        - code
        - message
        - retryable
        - request_id
      title: ErrorBody
      type: object
    Abstain:
      properties:
        min_probability:
          anyOf:
            - type: number
              maximum: 1
              minimum: 0
            - type: 'null'
          title: Min Probability
        cost:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost
      additionalProperties: false
      type: object
      title: Abstain
    ErrorDetail:
      properties:
        path:
          description: Where the problem is, such as ["body", "decisions", 0, "outcomes"].
          items:
            anyOf:
              - type: string
              - type: integer
          title: Path
          type: array
        message:
          title: Message
          type: string
        type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Type
      required:
        - path
        - message
      title: ErrorDetail
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: d1_sk_...
      description: Create an API key in the console. Required when accounts are enabled.

````