Cloud API

Retrieve a detect job by ID

GET https://api.imageintelligence.com/v2/detect/{id}

Retrieve a previously created detect job by id.

Request Parameters

NameInDescription
id
required		pathstring

The ID of a detect job

Response Parameters

Resources from the detect job successfully returned

id
required		string
createdAt
required		integer

UNIX timestamp for when the job was created

Format: int64

status
required		string

The status for a job

Possible values: COMPLETED_SUCCESSFULLY, COMPLETED_PARTIAL_ERROR, COMPLETED_ALL_ERROR, IN_PROGRESS

customId
optional		string

An arbitrary client specific resource identifier to reference this job (usually UUID)

feedId
optional		string

User specified ID to reference the source of the images within this job

webhookUrl
optional		string

Publicly accessible POST endpoint for receiving job status updates

jobResults
required		array[object]
class
required		string

A class you want to search for

image
optional		object
id
required		string

ID of the image

url
required		string

URL of the image

proxyUrl
optional		string

Proxy URL of the image

customId
optional		string

An arbitrary client specific resource identifier to reference this image (usually UUID)

confidence
required		number

The confidence value for the class

hitl
required		boolean

Whether human-in-the-loop verification was used for this class

imageResults
required		array[object]
id
required		string
url
required		string

URL of the image

proxyUrl
optional		string

Proxy URL of the image

customId
optional		string

An arbitrary client specific resource identifier to reference this image (usually UUID)

status
required		string

The processing status for an image

Possible values: COMPLETED_SUCCESSFULLY, IN_PROGRESS, UNKNOWN_ERROR, JOB_ERROR, IMAGE_DOWNLOAD_ERROR, INVALID_IMAGE_FORMAT_ERROR, SPIDERWEBS_ERROR, DETECTION_ENGINE_ERROR, MODEL_SERVICE_ERROR, MALFORMED_MESSAGE_ERROR

objects
required		array[object]
class
required		string

The class found

confidence
required		number

The confidence for the class

verdict
required		boolean

Whether we're certain if this class exists

Response Sample

{
  "id": "5d689c71-e68f-46c3-ac71-4053806e71de",
  "jobResults": [
    {
      "class": "person",
      "image": {
        "id": "52547074-a622-11e6-8f61-63f37dc33285",
        "url": "https://publicly.available.domain.net/image-001.jpg",
        "proxyUrl": "https://api.quickpix.io/images/c7e9a2ca-c2ee-4290-90b4-04fe3df35be0",
        "customId": "some_person_filled_image",
        "confidence": 0.9971387386
      },
      "hitl": true
    },
    {
      "class": "car",
      "image": {
        "id": "52547074-a622-11e6-8f61-63f37dc33286",
        "url": "https://publicly.available.domain.net/image-002.jpg",
        "proxyUrl": "https://api.quickpix.io/images/c7e9a2ca-c2ee-4290-90b4-04fe3df35be1",
        "customId": "some_car_filled_image",
        "confidence": 0.9987652302
      },
      "hitl": false
    }
  ],
  "imageResults": [
    {
      "id": "52547074-a622-11e6-8f61-63f37dc33285",
      "url": "https://publicly.available.domain.net/image-001.jpg",
      "proxyUrl": "https://api.quickpix.io/images/c7e9a2ca-c2ee-4290-90b4-04fe3df35be0",
      "customId": "some_person_filled_image",
      "objects": [
        {
          "class": "person",
          "confidence": 0.9971387386,
          "verdict": true
        }
      ],
      "status": "COMPLETED_SUCCESSFULLY"
    },
    {
      "id": "52547074-a622-11e6-8f61-63f37dc33286",
      "url": "https://publicly.available.domain.net/image-002.jpg",
      "proxyUrl": "https://api.quickpix.io/images/c7e9a2ca-c2ee-4290-90b4-04fe3df35be1",
      "customId": "some_car_filled_image",
      "objects": [
        {
          "class": "car",
          "confidence": 0.9987652302,
          "verdict": true
        }
      ],
      "status": "COMPLETED_SUCCESSFULLY"
    }
  ],
  "createdAt": 1487648348000,
  "status": "COMPLETED_SUCCESSFULLY",
  "customId": "6c78df0a-67b6-4d5f-93cf-5820cfee501c",
  "feedId": "Camera_123456",
  "webhookUrl": "https://publicly.available.domain.net/90f8754aa4e287bbb2c07ec99ade0de72ddbd4b6Et"
}