---
title: "Get Ml job"
method: GET
path: "/job/ml/{job_id}"
tags: ["job"]
---

# Get Ml job

`GET /job/ml/{job_id}`

## Request

- The document declares no server URL.
- Auth: OAuth 2
  - Password
  - Token URL: `/authentication/login`

## Path parameters

- `job_id` string, required

## Response `200`

Successful Response

- MlJobRead
  - `job_id` string, required: RQ job ID
  - `job_type` 'ml', required: Type of the job
  - `project_id` integer, required: Project ID associated with the job
  - `status` 'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled', required
  - `status_message` string, nullable: Status message
  - `current_step` integer, required: Current step in the job process
  - `steps` string[], required: Total number of steps in the job process
  - `input` MLJobInput, required
    - `project_id` integer, required: The ID of the Project to analyse
    - `ml_job_type` 'QUOTATION_ATTRIBUTION' | 'TAG_RECOMMENDATION' | 'COREFERENCE_RESOLUTION' | 'DOCUMENT_EMBEDDING' | 'SENTENCE_EMBEDDING', required
    - `specific_ml_job_parameters` union, required: Specific parameters for the MLJob w.r.t it's type
      - QuotationAttributionParams
        - `ml_job_type` 'QUOTATION_ATTRIBUTION', required: The type of the MLJob
        - `recompute` boolean: Whether to recompute already processed documents
      - DocTagRecommendationParams
        - `ml_job_type` 'TAG_RECOMMENDATION', required: The type of the MLJob
        - `multi_class` boolean: Tags are mutually exclusive if `False`
        - `tag_ids` integer[]: Tags to consider. If empty, all tags applied to any document are considered.
        - `method` 'SIMPLE' | 'KNN' | 'EXCLUSIVE'
      - CoreferenceResolutionParams
        - `ml_job_type` 'COREFERENCE_RESOLUTION', required: The type of the MLJob
        - `recompute` boolean: Whether to recompute already processed documents
      - DocumentEmbeddingParams
        - `ml_job_type` 'DOCUMENT_EMBEDDING', required: The type of the MLJob
        - `recompute` boolean: Whether to recompute already processed documents
      - SentenceEmbeddingParams
        - `ml_job_type` 'SENTENCE_EMBEDDING', required: The type of the MLJob
        - `recompute` boolean: Whether to recompute already processed documents
  - `output` unknown
  - `created` string, date-time, required: Created timestamp of the job
  - `finished` string, date-time, nullable: Finished timestamp of the job

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-05** `3bdfd02830b1`: 1 warning, 1 info
  - added the new `ml` enum value to the `job_type` response property for the response status `200`
  - the `job_type` response property const value `ml` was added for the status `200`
- **2026-07-16** `bd1187f3520e`: 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2025-08-22** `53e769440a25`: 2 warning
  - removed the optional property `detail/items/ctx` from the response with the `422` status
  - removed the optional property `detail/items/input` from the response with the `422` status

[Operation history](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api/changes/job/ml/:job_id/get.md)

---

[API](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api.md) - [All operations](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uhh-lt/apis/discourse-analysis-tool-suite-api/revisions/e498207e29f4?raw)