GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

Job history

Overview

The job history receives a set of parameters and returns related job lists and details. The Jobs service allows to monitor jobs and access the job history. Job history routes support pagination and may require filters.

The jobs object

{
    "jobIdentifier": "...",
    "submittedBy": "...",
    "accountIdentifier": "...",
    "model": {},
    "status": "...",
    "createdAt": "...",
    "updatedAt": "...",
    "submittedAt": "...",
    "total": 1,
    "pending": 1,
    "completed": 0,
    "failed": 0,
    "elapsedTime": 12345,
    "queueTime": 12345,
    "timeout": 99999,
    "user": {},
    "jobInputs": [],
    "inputByteAmount": 12345,
    "imageClassificationModel": true
}
ParameterTypeDescription
jobIdentifierstringThe job’s identifier.
submittedBystringThe API key that submitted the job.
accountIdentifierstringIdentifier linked to the account that requested the job.
modelobjectAn object that contains the model’s parameters. It can be used as a filter.
statusstringStatus of the jobs to be fetched. Defaults to all. It accepts all, timedout, pending, or terminated.
createdAtstringTime that the job was created in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
updatedAtstringTime that the job status was updated in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
submittedAtstringTime that the job was submitted in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
totalnumberAmount of items submitted to the job.
pendingnumberAmount of items in the item queue, not yet processed by the job.
completednumberAmount of items processed by the job.
failednumberAmount of items that the job couldn’t process.
queueTimenumberTime between the job is first submitted and it starts to run the first input in milliseconds.
elapsedTimenumberTime between the job starts to run until it is completed in milliseconds.
timeoutnumberContains a timeout in milliseconds for the job’s status to transition to TIMEDOUT. If it’s not set, jobs don’t timeout.
explainbooleanSets the explainability feature when a model offers the option.
userobjectAn object that contains the user’s parameters.
jobInputsarrayAn array that contains the input objects.
inputByteAmountnumberThe job’s total input weight in bytes.
imageClassificationModelbooleanA flag for image classification models. If true, it creates lightweight samples for the images.