Sign in
job

Start Crawler job

post/job/crawler

Request body

project_idinteger required

The ID of the Project to import the crawled data.

urlsstring[] required

List of URLs to crawl.

Response

Successful Response

job_idstring required

RQ job ID

job_typestring required

Type of the job

project_idinteger required

Project ID associated with the job

status'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required
status_messagestring nullable

Status message

current_stepinteger required

Current step in the job process

stepsstring[] required

Total number of steps in the job process

createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job

Changes

Changed in 3 of the 73 revisions of this API.233

  • 1af5a8046f202See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ea28bda836c511See the full diff
    • ▲

      added the new required request property settings/model

      new-required-request-property

    • ○

      added the required property input/settings/model to the response with the 200 status

      response-required-property-added

  • 53e769440a2513See the full diff
    • ▲

      removed the required property input/settings/model from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property settings/model

      request-property-removed

    • ●

      removed the optional property detail/items/ctx from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property detail/items/input from the response with the 422 status

      response-optional-property-removed

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog