> ## 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.

# Get training job progress

> Get training job progress by its key. The status indicates the progress.



## OpenAPI

````yaml api-reference/openapi.yaml GET /api/v1/training/{trainingJobKey}/progress
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/training/{trainingJobKey}/progress:
    get:
      tags:
        - Training
      summary: Get training job progress
      description: Get training job progress by its key. The status indicates the progress.
      operationId: getTrainingProgress
      parameters:
        - name: trainingJobKey
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Training job progress successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrainingJobProgressOutput'
              examples:
                Successful progress response:
                  summary: Successful progress response
                  value: |
                    {
                      "status": "COMPLETED",
                      "jobs": [
                          {
                              "trainingJobKey": "bc9aa412-8d4f-4b00-89af-0e6e3dcf8e57",
                              "algorithm": "BSEV01",
                              "status": "NOT_COMPLETED",
                              "latestPerformance": 0.6198999,
                              "recentPerformances": [
                                  0.6198999,
                                  0.6198999,
                                  0.6198999,
                                  0.6198999,
                                  0.6198999
                              ]
                          },
                          {
                              "trainingJobKey": "d9ab4260-6416-45d6-91e4-7b0b8a0ad56b",
                              "algorithm": "BFIF01",
                              "status": "NOT_COMPLETED",
                              "latestPerformance": 0.7714181,
                              "recentPerformances": [
                                  0.7712554,
                                  0.7712554,
                                  0.77137744,
                                  0.7714181
                              ]
                          },
                          {
                              "trainingJobKey": "e7edd490-3ee2-49f8-a49c-e9f9759965e8",
                              "algorithm": "BSIX01",
                              "status": "NOT_COMPLETED",
                              "latestPerformance": 0.859485,
                              "recentPerformances": [
                                  0.85789835,
                                  0.86017656,
                                  0.8659534,
                                  0.8659534,
                                  0.859485
                              ]
                          },
                          {
                              "trainingJobKey": "f2275fde-73ed-43d0-948a-17ff8f586874",
                              "algorithm": "BSEV02",
                              "status": "COMPLETED",
                              "latestPerformance": 0.92002606,
                              "recentPerformances": [
                                  0.9193752,
                                  0.91998535,
                                  0.91998535,
                                  0.9197413,
                                  0.92002606
                              ]
                          }
                      ]
        '400':
          description: Invalid training progress request
        '500':
          description: Internal server error
components:
  schemas:
    TrainingJobProgressOutput:
      required:
        - status
      type: object
      properties:
        status:
          $ref: '#/components/schemas/TrainingJobStatus'
        targetPerformance:
          type: number
          format: double
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/TrainingJobProgressItem'
        nextPollAfterSeconds:
          description: >-
            How long to wait before asking again. Absent once the job has
            finished — there is nothing further to wait for, and a client that
            honours this stops polling.
          type: integer
          nullable: true
    TrainingJobStatus:
      type: string
      description: >
        Status of training: 


        * `PENDING` - The training job has been created and is pending execution

        * `RUNNING` - The training job is currently executing and progressing

        * `COMPLETED` - The training job has completed execution successfully,
        reaching the target performance. A model has been generated. 

        * `TIMED_OUT` - The training job could not reach the target performance
        in the configured 

        * `CANCELLED` - The training job has been cancelled by the user 

        * `NOT_COMPLETED` - The training job has stalled without making progress
        in a specified timeframe

        * `FAILED` - The training job has failed due to an error
      enum:
        - PENDING
        - RUNNING
        - COMPLETED
        - TIMED_OUT
        - CANCELLED
        - FAILED
        - NOT_COMPLETED
    TrainingJobProgressItem:
      type: object
      properties:
        trainingJobKey:
          type: string
          format: uuid
        attemptNumber:
          description: >-
            Which of the job's attempts this is, counting from one. Present
            where a job runs many attempts rather than one job per algorithm —
            the attempts have no key of their own.
          type: integer
          nullable: true
        algorithm:
          type: string
        status:
          $ref: '#/components/schemas/TrainingJobStatus'
        latestPerformance:
          type: number
          format: double
        recentPerformances:
          type: array
          items:
            type: number
            format: double
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````