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

# Get Crawler job

`GET /job/crawler/{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

- CrawlerJobRead
  - `job_id` string, required: RQ job ID
  - `job_type` 'crawler', 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` CrawlerJobInput, required
    - `project_id` integer, required: The ID of the Project to import the crawled data.
    - `settings` ProcessingSettings, required
      - `extract_images` boolean, required: Whether to extract images from the documents
      - `pages_per_chunk` integer, required: Number of pages to chunk the documents into
      - `keyword_number` integer, required: Number of keywords to extract
      - `keyword_deduplication_threshold` number, required: Threshold for keyword deduplication (0.0 - 1.0)
      - `keyword_max_ngram_size` integer, required: Maximum n-gram size for keyword extraction
      - `language` 'auto' | 'de' | 'en' | 'it', required
      - `model` string, required: Large Language Model to use for processing
    - `urls` string[], required: List of URLs to crawl.
  - `output` CrawlerJobOutput
    - `crawled_data_zip` string, path, required
  - `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 `crawler` enum value to the `job_type` response property for the response status `200`
  - the `job_type` response property const value `crawler` 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
- **2026-07-01** `ea28bda836c5`: 1 info
  - added the required property `input/settings/model` to the response with the `200` status
- **2025-08-22** `53e769440a25`: 1 breaking, 2 warning
  - removed the required property `input/settings/model` from the response with the `200` status
  - 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/crawler/: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)