Skip to navigation
Synth API ReferenceJobs

Cancel a job

Cancel a queued job, or one that is running (its results are discarded). Canceled jobs aren’t billed.

Authentication

AuthorizationBearer

An API key, or an OAuth 2.0 access token, with the synth:process scope.

Path parameters

job_idstringRequiredformat: "uuid"

Response

Successful Response
idstringformat: "uuid"
statusenum
Allowed values:
created_atdatetime
num_documentsinteger
Clinical documents requested.
attemptsinteger

Times processing started; a job interrupted on our side is retried.

started_atdatetime or nullOptional
finished_atdatetime or nullOptional
errorobject or nullOptional
Why the job failed, if it did.
summaryobject or nullOptional
The patient generated, once succeeded.
resultslist of objectsOptional
Files ready to download.
results_expire_atdatetime or nullOptional
Files not downloaded by then are deleted.

Errors

401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error