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
• completed: The job is completed successfully
• failed: The job failed with an error

Possible values: [pending, completed, failed]

error object

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

codestringrequired

Error codes:

• failed_to_fetch_from_url: There was an issue fetching image from the provided image URL
• image_already_protected: The image is already protected with SASHA Signature
• image_load_failed: The image is not a valid image e.g. corrupted or invalid format
• image_too_large: The image is too large to process
• image_too_small: The image is too small to process
• internal: An internal error occurred

Possible values: [failed_to_fetch_from_url, image_already_protected, image_load_failed, image_too_large, image_too_small, 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_id object

The Signature identifier (populated when job status is completed). Will be null if no signature was found in the image.

oneOf

SignatureID

string

The globally unique identifier of the SASHA Signature embedded into the image.

The SignatureID is an unsigned 64-bit integer.

In JSON representation, the SignatureID is represented as a string.

null

null

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": "failed_to_fetch_from_url",
        "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"
    }
  ]
}