Developers

Job API Reference

This section covers all endpoints related to job.

Create Job

Create a job.

Endpoint:

Parameters

ParameterTypeRequiredDescription
chute_idstringYes
methodstringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Delete Job

Delete a job.

Endpoint:

Parameters

ParameterTypeRequiredDescription
job_idstringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Finish Job And Get Upload Targets

Mark a job as complete (which could be failed; "done" either way)

Endpoint:

Parameters

ParameterTypeRequiredDescription
job_idstringYes
tokenstringYes

Responses

Status CodeDescription
200Successful Response
422Validation Error

Complete Job

Final update, which checks the file uploads to see which were successfully transferred etc.

Endpoint:

Parameters

ParameterTypeRequiredDescription
job_idstringYes
tokenstringYes

Responses

Status CodeDescription
200Successful Response
422Validation Error

Get Job

Get a job.

Endpoint:

Parameters

ParameterTypeRequiredDescription
job_idstringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.


Upload Job File

Upload a job's output file.

Endpoint:

Parameters

ParameterTypeRequiredDescription
job_idstringYes
tokenstringYes

Responses

Status CodeDescription
200Successful Response
422Validation Error

Download Output File

Download a job's output file.

Endpoint:

Parameters

ParameterTypeRequiredDescription
job_idstringYes
file_idstringYes
X-Chutes-Hotkeystring | nullNo
X-Chutes-Signaturestring | nullNo
X-Chutes-Noncestring | nullNo
Authorizationstring | nullNo

Responses

Status CodeDescription
200Successful Response
422Validation Error

Authentication

This endpoint requires authentication.