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

# Cancel a run

> Requests cancellation. Cancellation is cooperative, not immediate.

- A run that has not started yet stops at once, state `CANCELLED`.
- A running run keeps going to its next round boundary, then stops. Expect it to keep reporting a
  running and still-advancing state for **5–15 minutes**, sometimes ~20.
- Cancelling during the early setup phases takes longer still, since the request is not observed
  until the first round check.
- A finished run returns `409`.

Round wall-clock is dominated by fixed overhead, not by the size of your data, so a small dataset
does not cancel any faster.

Never assume the run has stopped. Poll `GET /{featureRefinementKey}/progress` until the state is
terminal. A `CANCELLED` entry appears on `recentActivities` as soon as the request is accepted,
which is observable before the top-level state flips.




## OpenAPI

````yaml api-reference/openapi.yaml POST /api/v1/feature-refinery/{featureRefinementKey}/cancel
openapi: 3.0.1
info:
  title: MathFi.ai API
  description: >
    The MathFi.ai REST API runs the two products end to end.


    **Feature Refinery** takes your labelled data and works out which columns

    actually carry the signal. It returns a reduced train and test pair, a

    per-column keep/remove decision, and the performance target the refined data

    reached.


    **Model Crucible** takes a dataset, trains every algorithm family against it

    at once, ranks the results on held-out data by fewest wrong decisions, and

    keeps the best three as versions of one model. You pick which one
    predictions

    run against.


    Everything is asynchronous: you create a thing, upload to a signed URL,
    start

    it, then poll until the state is terminal. Nothing streams and nothing
    blocks.
  contact:
    name: MathFi.ai
    url: https://mathfi.ai
    email: support@mathfi.ai
  license:
    name: MathFi.ai
    url: https://mathfi.ai
  version: 1.0.0
servers:
  - url: https://{tenant}-api.mathfi.ai
    description: >-
      Your tenant's API. Each customer has their own, so the host varies.
      Replace {tenant} with the name issued when your tenant was created.
    variables:
      tenant:
        default: your-tenant
        description: The tenant name issued to you.
security:
  - BearerAuth: []
tags:
  - name: Authentication
    description: Exchange credentials for a bearer token
  - name: Feature Refinery
    description: Reduce a dataset to the columns that earn their place
  - name: Datasets
    description: >-
      Prepare labelled data for training, from uploads or from a finished
      refinement
  - name: Training
    description: Run the Crucible against a dataset and choose the champion model
  - name: Models
    description: Trained models and their versions
  - name: Predictions
    description: Score unlabelled data against a champion model
paths:
  /api/v1/feature-refinery/{featureRefinementKey}/cancel:
    post:
      tags:
        - Feature Refinery
      summary: Cancel a run
      description: >
        Requests cancellation. Cancellation is cooperative, not immediate.


        - A run that has not started yet stops at once, state `CANCELLED`.

        - A running run keeps going to its next round boundary, then stops.
        Expect it to keep reporting a
          running and still-advancing state for **5–15 minutes**, sometimes ~20.
        - Cancelling during the early setup phases takes longer still, since the
        request is not observed
          until the first round check.
        - A finished run returns `409`.


        Round wall-clock is dominated by fixed overhead, not by the size of your
        data, so a small dataset

        does not cancel any faster.


        Never assume the run has stopped. Poll `GET
        /{featureRefinementKey}/progress` until the state is

        terminal. A `CANCELLED` entry appears on `recentActivities` as soon as
        the request is accepted,

        which is observable before the top-level state flips.
      operationId: cancelFeatureRefinement
      parameters:
        - name: featureRefinementKey
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Cancellation applied immediately, or accepted to take effect at the
            next round
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureRefineryCancelOutput'
        '404':
          description: Unknown feature refinement key
        '409':
          description: The run has already finished and cannot be cancelled
        '500':
          description: Internal server error
components:
  schemas:
    FeatureRefineryCancelOutput:
      description: >-
        The run's state after a cancel request — CANCELLED when it applied
        immediately (the run had not started), or the current running state when
        cancellation will take effect at the next round.
      required:
        - featureRefinementKey
        - state
      type: object
      properties:
        featureRefinementKey:
          type: string
          format: uuid
        state:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````