Imago API

List image metadata

Servers
https://imago.api.seequent.com/integrate/2

GET

/image-metadata

Searches for metadata of images matching a search criteria.

Request

Query parameters

workspaceNamestring

Restrict searching to this workspace.

workspaceIdstring

Restrict searching to this workspace. ID must be an exact match.

datasetNamestring

Restrict searching to this dataset.

datasetIdstring

Restrict searching to this dataset. ID must be an exact match.

collectionNamestring

Restrict searching to this collection.

collectionIdstring

Restrict searching to this collection. ID must be an exact match.

imageryTypeNamestring

Restrict searching to this imagery type

imageryTypeIdstring

Restrict searching to this imagery type. ID must be an exact match.

imageryNamestring

Restrict searching to this imagery.

imageryIdstring

Restrict searching to this imagery. ID must be an exact match.

imageTypeNamestring

Restrict searching to this image type

imageTypeIdstring

Restrict searching to this image type. ID must be an exact match.

imageIdstring

Restrict searching to this image. ID must be an exact match.

matchstring

Determines how the search pattern matches on the name fields.
Default value: equals
Allowed values: 'equals', 'includes', 'startswith', 'endswith', 'like'

updatedSincenumber

Restrict searching to images that have been updated in the last number of specified days.

uploadedSincenumber

Restrict searching to images that have had images uploaded in the last number of specified days.

limitnumber

Limit how many images are returned. The default and maximum setting restricts the output to 1000 images.

offsetnumber

Return images starting at this offset.

deletedboolean

If set to true, only return deleted images. If set to false, only return active images. defaults to false.

Responses

200

Successful response.

Response schema

imagesimageMetadataSchema[]

List of matching images

idstring

Image identifier.

checksumstring

Checksum value for the image.

heightnumber

Image's height in pixels.

widthnumber

Image's width in pixels.

fileSizenumber

Size of image file.

mimeTypestring

Image's mime type.

uploadedBystring

User account that uploaded the image.

uploadedOndate

Date/time that the image was uploaded.

urlstring

Timed access to a URL to directly download the image.

updatedAtdate

Last datetime that the image was updated.

znumber

Elevation/Z coordinate of the image.

ynumber

Latitude/Y coordinate of the image.

xnumber

Longitude/X coordinate of the image.

endDepthnumber

End depth of the image.

startDepthnumber

Start depth of the image.

workspaceIdstring

Workspace identifier that the image belongs to.

workspaceNamestring

Workspace name that the image belongs to.

datasetIdstring

Dataset identifier that the image belongs to.

datasetNamestring

Dataset name that the image belongs to.

collectionIdstring

Collection identifier that the image belongs to.

collectionNamestring

Collection name that the image belongs to.

imageryTypeIdstring

Imagery type identifier that the image belongs to.

imageryTypeNamestring

Imagery type name that the image belongs to.

imageryIdstring

Imagery identifier that the image belongs to.

imageryNamestring

Imagery name that the image belongs to.

imageTypeIdstring

Image type identifier.

imageTypeNamestring

Image type name.

metapaginationMetaSchema

limitinteger

The maximum number of items to return. Optional.

offsetinteger

The number of items to skip before starting to collect the result set.

Example response

{
  "images": [
    {
      "id": "e2f26f0d-51c8-468e-b02f-29b4dc2217a2",
      "workspaceId": "a27b51bf-b918-4fb4-a28f-4f089bf646a8",
      "workspaceName": "Firefly Resource Development",
      "datasetId": "71b93d30-8e5f-4b07-9f08-8e6bf5a72a50",
      "datasetName": "Drilling Chips",
      "collectionId": "054bf4c2-84cc-4d30-b4dc-cc81c77b7f25",
      "collectionName": "RC-01001",
      "imageryTypeId": "6a69bf8e-c03c-4ed2-8a62-d6feac838f12",
      "imageryTypeName": "Chips",
      "imageryId": "b91119e8-cee5-4c11-ad14-fe1dcb0c1c66",
      "imageryName": "Hole 1",
      "imageTypeId": "f16c5dbe-f455-4076-8358-ffda8f538814",
      "imageTypeName": "Wet",
      "updatedAt": "2011-10-05T14:48:00.000Z",
      "uploadedOn": "2022-05-02T06:25:32.085Z",
      "uploadedBy": "ImagoLive",
      "mimeType": "image/png",
      "fileSize": 40192,
      "width": 1024,
      "height": 768,
      "checksum": "x7Rpt+5ET3C3vQataO7tEA==",
      "startDepth": 5,
      "endDepth": 15,
      "url": "https://imago.api.seequent.com/integrate/2/image/b91119e8-cee5-4c11-ad14-fe1dcb0c1c66/?userId=34a3f4ae-d53c-43d4-8545-a552c2a24c54&start=2025-04-23T03:59:36.499Z&expiry=2025-04-23T15:59:36.499Z&sig=4284b5576fffd3ebb94740025415aa2138d514139c5c61c5ef0b7af912da3fb8",
      "x": 10,
      "y": 20,
      "z": 30
    }
  ],
  "meta": {
    "limit": 1000,
    "offset": 0
  }
}

401

Unauthorized

404

Internal error occurred during the request.

500

Internal Server Error