Image annotation - JSON

  • Updated On Mar 13, 2025
  • Published on Dec 16, 2021
Prev Next

Each entity in our system has a JSON code that represents its data within our system.

Read here about downloading the JSON file of an item’s annotations.

This JSON code includes the entity's data related to our software and its metadata.

Image JSON Format

{
	"annotations": [
		{
  "id": "67ceef3bb37fa82ff71ba563",
  "datasetId": "67ceef0416595b6856e210e0",
  "url": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
  "dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
  "createdAt": "2025-03-10T13:55:07.498Z",
  "dir": "/",
  "filename": "/images.png",
  "type": "file",
  "hidden": false,
  "metadata": {
    "system": {
      "channels": 3,
      "encoding": "7bit",
      "height": 480,
      "isBinary": true,
      "mimetype": "image/jpeg",
      "originalname": "images.png",
      "refs": [],
      "size": 24018,
      "taskStatusLog": [],
      "thumbnailId": "67ceef3f20b914f28531df74",
      "width": 640
    }
  },
  "name": "images.png",
  "creator": "user@dataloop.ai",
  "updatedAt": "2025-03-10T13:55:11.205Z",
  "updatedBy": "user@dataloop.ai",
  "stream": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563/stream",
  "thumbnail": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563/thumbnail",
  "annotations": [
    {
      "id": "67ceef62995ecd2df020d514",
      "datasetId": "67ceef0416595b6856e210e0",
      "itemId": "67ceef3bb37fa82ff71ba563",
      "url": "https://gate.dataloop.ai/api/v1/annotations/67ceef62995ecd2df020d514",
      "item": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
      "dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
      "type": "class",
      "label": "Bird-1",
      "attributes": [],
      "metadata": {
        "system": {
          "attributes": {},
          "automated": false,
          "clientId": "4e3b6a65-40f4-4ffc-9f63-22199922b8db",
          "endFrame": 0,
          "endTime": 0,
          "frame": 0,
          "itemLinks": [],
          "objectId": "1",
          "openAnnotationVersion": "1.91.1-prod.3",
          "recipeId": "64b4d4652679f454253ffddb",
          "snapshots_": [],
          "startTime": 0,
          "system": false
        },
        "user": {}
      },
      "creator": "user@dataloop.ai",
      "createdAt": "2025-03-10T13:55:46.394Z",
      "updatedBy": "user@dataloop.ai",
      "updatedAt": "2025-03-10T13:55:46.394Z",
      "hash": "824c48b05a2eb5caf95090121db2c11f4d83b5ce",
      "source": "ui"
    },
    {
      "id": "67ceef62995ecd68f320d515",
      "datasetId": "67ceef0416595b6856e210e0",
      "itemId": "67ceef3bb37fa82ff71ba563",
      "url": "https://gate.dataloop.ai/api/v1/annotations/67ceef62995ecd68f320d515",
      "item": "https://gate.dataloop.ai/api/v1/items/67ceef3bb37fa82ff71ba563",
      "dataset": "https://gate.dataloop.ai/api/v1/datasets/67ceef0416595b6856e210e0",
      "type": "box",
      "label": "Bird-1",
      "attributes": [],
      "coordinates": [
        {
          "x": 51.09,
          "y": 127.96,
          "z": 0
        },
        {
          "x": 464.82000000000005,
          "y": 376.36,
          "z": 0
        }
      ],
      "metadata": {
        "system": {
          "attributes": {
            "1": "No"
          },
          "automated": false,
          "clientId": "2bfa1965-9482-4cb0-8a6f-c151ef7b6535",
          "coordinateVersion": "v2",
          "endFrame": 0,
          "endTime": 0,
          "frame": 0,
          "itemLinks": [],
          "objectId": "2",
          "openAnnotationVersion": "1.91.1-prod.3",
          "recipeId": "64b4d4652679f454253ffddb",
          "snapshots_": [],
          "startTime": 0,
          "system": false
        },
        "user": {}
      },
      "creator": "user@dataloop.ai",
      "createdAt": "2025-03-10T13:55:46.394Z",
      "updatedBy": "user@dataloop.ai",
      "updatedAt": "2025-03-10T13:55:46.394Z",
      "hash": "304f3b1f01262e17a862d98a745a47cde8b90504",
      "source": "ui"
    }
  ],
  "annotationsCount": 2,
  "annotated": true
}]
}

Image JSON Fields Description

Key Name Definition Parent Key
id Unique identifier for the item Root
datasetId Unique identifier for the dataset Root
url URL to access the item Root
dataset URL to access the dataset Root
createdAt Timestamp when the item was created Root
dir Directory path of the item Root
filename Name of the file Root
type Type of the item (e.g., file) Root
hidden Boolean indicating if the item is hidden Root
metadata Metadata associated with the item Root
metadata.system System-level metadata metadata
channels Number of color channels in the image metadata.system
encoding Encoding type of the file metadata.system
height Height of the image in pixels metadata.system
isBinary Boolean indicating if the file is binary metadata.system
mimetype MIME type of the file metadata.system
originalname Original name of the file metadata.system
refs List of reference items metadata.system
size Size of the file in bytes metadata.system
taskStatusLog Log of task statuses metadata.system
thumbnailId Unique identifier for the thumbnail metadata.system
width Width of the image in pixels metadata.system
name Name of the item Root
creator Creator of the item Root
updatedAt Timestamp when the item was last updated Root
updatedBy User who last updated the item Root
stream URL to stream the image Root
thumbnail URL to the thumbnail image Root
annotations List of annotations for the item Root
annotations.id Unique identifier for the annotation annotations[]
annotations.datasetId Dataset ID associated with the annotation annotations[]
annotations.itemId Item ID the annotation belongs to annotations[]
annotations.url URL to access the annotation annotations[]
annotations.item URL to the annotated item annotations[]
annotations.dataset URL to the dataset of the annotation annotations[]
annotations.type Type of annotation (e.g., class, box) annotations[]
annotations.label Label of the annotation annotations[]
annotations.attributes List of attributes associated with the annotation annotations[]
coordinates List of coordinate points for the annotation annotations[]
coordinates.x X-coordinate of the annotation point coordinates
coordinates.y Y-coordinate of the annotation point coordinates
coordinates.z Z-coordinate of the annotation point (depth, if applicable) coordinates
annotations.metadata Metadata related to the annotation annotations[]
metadata.system System-related metadata for the annotation annotations.metadata
attributes Attributes related to the annotation metadata.system
automated Boolean indicating if the annotation was generated automatically metadata.system
clientId Client identifier metadata.system
coordinateVersion Version of the coordinate system used metadata.system
endFrame End frame of the annotation metadata.system
endTime End time of the annotation (in seconds) metadata.system
frame Frame number of the annotation metadata.system
itemLinks List of linked items metadata.system
objectId Object ID associated with the annotation metadata.system
openAnnotationVersion Version of the annotation tool metadata.system
recipeId Recipe ID used for annotation metadata.system
snapshots_ Snapshots related to the annotation metadata.system
startTime Start time of the annotation (in seconds) metadata.system
system Boolean indicating if it's a system annotation metadata.system
user User-related metadata metadata
creator User who created the annotation annotations[]
createdAt Timestamp when the annotation was created annotations[]
updatedBy User who last updated the annotation annotations[]
updatedAt Timestamp when the annotation was last updated annotations[]
hash Hash value associated with the annotation annotations[]
source Source of the annotation (e.g., UI) annotations[]
annotationsCount Total count of annotations Root
annotated Boolean indicating if the item is annotated Root