Skip to main content

Delete a task

DELETE 
/tasks/:jobid

Delete a task that has been submitted, whether it is in progress or completed, along with both the original and processed documents associated with it.

Request​

Path Parameters

    jobid stringrequired

    Id of the task to retrieve.

Header Parameters

    x-amz-security-token stringrequired

    Request signature (see the authentication section).

Responses​

Successful query.

Schema

    clientFilename string

    File name as submitted

    jobid stringrequired

    ID of the task

    submitted integerrequired

    Time of creation (seconds since epoch)

    companyName stringrequired

    Your client name

    client stringrequired

    Your organisation name

    modelUrl uri

    Possible values: Value must match regular expression ^https://

    URL to download model (if requested with includePresigned)

    modelFilename string

    Path of the output model file in S3 (see modelUrl for a presigned URL)

    originalFilename string

    Path of the original uploaded file in S3

    clientModelFilename string

    Suggested file name for the output model: clientFilename, but with extension changed to .json

    status stringrequired

    Possible values: [PENDING_UPLOAD, PROCESSING, DELETED, SUCCESS]

    Task status

Loading...