Jobs

Get a durable job and its result when complete

get/job/{jobId}

Request

  • Base URL: https://api.domscout.io
  • URL: https://api.domscout.io/job/{jobId}
  • Auth: API key in header x-api-key

Response

Job state. A completed job can include its safe result; it does not promise saved-capture retention or artifact descriptors.

status'pending' | 'processing' | 'retrying' | 'done' | 'error' | 'cancel_requested' | 'cancelled' required
jobIdstring uuid required
createdAtstring date-time
startedAtstring date-time nullable
doneAtstring date-time nullable
completedAtstring date-time nullable
messagestring
codestring
suggestionsstring[]
recoveredboolean
cancellationRequestedAtstring date-time nullable
acceptedboolean

Present on a successful cooperative cancellation response.

Changes

No recorded changes to this operation across all 1 revision of this API.