jobs

A job's status; with `?wait=60`, held until it finishes.

With wait, the request is held open until the job leaves queued/running or wait seconds pass, whichever is first, and the body is the same job resource either way. Loop on it instead of sleeping: each call returns the moment the job is done. When too many callers are already held the job's current state comes back at once with Retry-After; Preference-Applied: wait means the hold happened.

get/v1/jobs/{job_id}

Request

  • Base URL: https://api.japanfold.aiand.com
  • URL: https://api.japanfold.aiand.com/v1/jobs/{job_id}
  • Auth: one of:
    • none
    • HTTP bearer

Path parameters

job_idstring required

Query parameters

waitinteger

Seconds to hold the request for the job to finish (0-60; larger values are capped at 60).

Response

Job

artifactsobject[]

Present on a succeeded job read by its id (not in the list), when it has at most 20 files: the same entries as artifacts in its results. A job with more files lists them only in its results.

attemptinteger

Present only when the job's structure is on its second run, because the box running it stopped answering (hung, or its agent died); its progress started over. A job of several structures carries it on the retried entry of targets. Billed once.

created_atstring date-time nullable
doneinteger
downloadstring

Present on a succeeded job read by its id: one shell command that fetches every result file into the current directory, reading the key from JAPANFOLD_API_KEY. Past 20 files it fetches and unzips the archive instead.

email_when_doneboolean

Present once POST /v1/jobs/{id}/notify has been asked.

errorstring nullable

Why the job failed; on a succeeded job, what it could not deliver (see partial).

finished_atstring date-time nullable
idstring required
kind'predict' | 'design' | 'embed' required
linksobject
modelstring nullable
namestring
object'job' required
progressnumber nullable

0..1, or null when indeterminate

protocolstring nullable
results_readyboolean
stagestring nullable
started_atstring date-time nullable
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
totalinteger
waiting_for_deviceboolean

Present and true only while the job has been accepted but no processor is free for it yet. The job is queued, not stalled.

Changes

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