ListJobsResponse

jobs object[]required

List of jobs

Array [

job_idstringrequired

The ID of the job

typeJobType (string)required

The type of the job:

• embed-signature: The job is to embed a SASHA Signature into an image
• lookup-signature: The job is to check if an image is already protected with SASHA Signature

Possible values: [embed-signature, lookup-signature]

statusJobStatus (string)required

The status of the job:

• pending: The job has been accepted and is waiting to be processed
• in_progress: The job is being processed
• completed: The job is completed successfully
• failed: The job failed with an error

Possible values: [pending, in_progress, completed, failed]

error object

The error that occurred while processing the job, if the job status is failed

codestringrequired

Error codes:

• unsupported_format: The image format is not supported
• failed_to_fetch_from_url: There was an issue fetching image from the provided image URL
• internal: An internal error occurred

Possible values: [unsupported_format, failed_to_fetch_from_url, internal]

messagestringrequired

A developer-facing error message

output_urlstring

The URL of the result media file (only populated if job status is completed and type is embed-signature)

output_url_expires_atstring<date-time>

The date and time the output URL will expire

signature_idSignatureID (string)

The Signature identifier (populated when job status is completed)

created_atstring<date-time>required

The date and time the job was created

updated_atstring<date-time>required

The date and time the job was last updated

]

ListJobsResponse

{
  "jobs": [
    {
      "job_id": "string",
      "type": "embed-signature",
      "status": "pending",
      "error": {
        "code": "unsupported_format",
        "message": "string"
      },
      "output_url": "string",
      "output_url_expires_at": "2024-07-29T15:51:28.071Z",
      "signature_id": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}