Item JSON Format

Updated On 21 Jan 2025

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Item

An 'Item' is a Dataloop entity that represents the required data for annotation. It can consist of a single file or multiple files. For instance, a 'Video Item' comprises a sole video file, while a 'Lidar Item' includes multiple PCD frames stitched into one item, presenting them as a sequence. Each Dataloop Annotation Studio has its unique item structure.

Download an Item

A JSON structure represents the item. Refer to the Export selected/queried items section to learn about downloading the item JSON file.

JSON

JSON is a minimal text-based data exchange format that is used primarily to transmit data between a server and a web application. To understand more about JSON, go here.

Format Details

A few Item formats are provided below for your reference.

PCD Format


{
  "id": "65029ac313c0345fc63a5b5c",
  "datasetId": "6458d7e0a4aaff79f2f8e16f",
  "url": "https://rc-gate.dataloop.ai/api/v1/items/65029ac313c0345fc63a5b5c",
  "dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6458d7e0a4aaff79f2f8e16f",
  "createdAt": "2023-09-14T05:31:47.195Z",
  "dir": "/098/velodyne_points",
  "filename": "/098/velodyne_points/72.pcd",
  "type": "file",
  "hidden": false,
  "metadata": {
    "system": {
      "encoding": "7bit",
      "groundItemId": "6502a0d544ea32436f810445",
      "isBinary": false,
      "mimetype": "application/pcd",
      "originalname": "72.pcd",
      "preprocessPhase": "ITEM_UPLOADED",
      "refs": [
        {
          "id": "651ea7f0a5b5caf51279263c",
          "type": "task"
        },
        {
          "id": "651ea7f2a5b5cab4bc79263d",
          "type": "assignment"
        },
        {
          "id": "653c020f99b05236549d0760",
          "type": "task"
        },
        {
          "id": "653c021099b05235e69d0761",
          "type": "assignment"
        },
        {
          "id": "66323058182cee258804de3a",
          "type": "assignment"
        },
        {
          "id": "66323058182cee792704de39",
          "type": "task"
        },
        {
          "id": "66b469238649ed335af72ef2",
          "type": "task"
        },
        {
          "id": "66b469248649eddee0f72ef4",
          "type": "assignment"
        },
        {
          "id": "67864c31856788b710ca312c",
          "type": "task"
        },
        {
          "id": "67864c31856788b9c0ca312d",
          "type": "assignment"
        }
      ],
      "size": 13888853,
      "taskStatusLog": []
    },
    "user": {
      "lidar_ground_detection": {
        "groundMapId": "65084f1b932416453f8a14ac"
      }
    }
  },
  "name": "72.pcd",
  "creator": "user@dataloop.ai",
  "updatedAt": "2023-09-14T05:31:47.999Z",
  "updatedBy": "user@dataloop.ai",
  "stream": "https://rc-gate.dataloop.ai/api/v1/items/65029ac313c0345fc63a5b5c/stream",
  "thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/65029ac313c0345fc63a5b5c/thumbnail",
  "annotations": [],
  "annotationsCount": 0,
  "annotated": false
}

MP3 Format


{
  "id": "66cd77785e170e08c6b895d6",
  "datasetId": "650038ff86b54fd9dbec7568",
  "url": "https://rc-gate.dataloop.ai/api/v1/items/66cd77785e170e08c6b895d6",
  "dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/650038ff86b54fd9dbec7568",
  "createdAt": "2024-08-27T06:51:36.195Z",
  "dir": "/",
  "filename": "/Audio file.mp3",
  "type": "file",
  "hidden": false,
  "metadata": {
    "system": {
      "audioSpeakers": {
        "male1": "John",
        "male2": "Smith"
      },
      "encoding": "7bit",
      "isBinary": true,
      "mimetype": "audio/mpeg",
      "originalname": "Audio file.mp3",
      "refs": [],
      "size": 5289384,
      "taskStatusLog": []
    }
  },
  "name": "Audio file.mp3",
  "creator": "user@dataloop.ai",
  "updatedAt": "2024-09-25T10:54:13.904Z",
  "updatedBy": "user@dataloop.ai",
  "stream": "https://rc-gate.dataloop.ai/api/v1/items/66cd77785e170e08c6b895d6/stream",
  "thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/66cd77785e170e08c6b895d6/thumbnail",
  "annotations": [],
  "annotationsCount": 0,
  "annotated": false
}

MP4 Format


{
  "id": "65950dd53dd3b69ea61ad32b",
  "datasetId": "655f1387ee8ab462056613f8",
  "url": "https://rc-gate.dataloop.ai/api/v1/items/65950dd53dd3b69ea61ad32b",
  "dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/655f1387ee8ab462056613f8",
  "createdAt": "2024-01-03T07:33:40.281Z",
  "dir": "/videos",
  "filename": "/videos/pexels-cottonbro-5722113 (2160p).mp4",
  "type": "file",
  "hidden": false,
  "metadata": {
    "fps": 25,
    "startTime": 0,
    "system": {
      "duration": 38.76,
      "encoding": "7bit",
      "ffmpeg": {
        "avg_frame_rate": "25/1",
        "bit_rate": "17389016",
        "bits_per_raw_sample": "8",
        "chroma_location": "left",
        "closed_captions": 0,
        "codec_long_name": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
        "codec_name": "h264",
        "codec_tag": "0x31637661",
        "codec_tag_string": "avc1",
        "codec_type": "video",
        "coded_height": 4096,
        "coded_width": 2160,
        "color_primaries": "bt709",
        "color_range": "tv",
        "color_space": "bt709",
        "color_transfer": "bt709",
        "disposition": {
          "attached_pic": 0,
          "clean_effects": 0,
          "comment": 0,
          "default": 1,
          "dub": 0,
          "forced": 0,
          "hearing_impaired": 0,
          "karaoke": 0,
          "lyrics": 0,
          "original": 0,
          "timed_thumbnails": 0,
          "visual_impaired": 0
        },
        "duration": "38.760000",
        "duration_ts": 969,
        "has_b_frames": 2,
        "height": 4096,
        "index": 0,
        "is_avc": "true",
        "level": 52,
        "nal_length_size": "4",
        "nb_frames": "969",
        "nb_read_frames": "969",
        "nb_read_packets": "969",
        "pix_fmt": "yuv420p",
        "profile": "High",
        "r_frame_rate": "25/1",
        "refs": 5,
        "start_pts": 0,
        "start_time": "0.000000",
        "tags": {
          "creation_time": "2020-10-28T12:15:28.000000Z",
          "encoder": "AVC Coding",
          "handler_name": "L-SMASH Video Handler",
          "language": "und",
          "vendor_id": "[0][0][0][0]"
        },
        "time_base": "1/25",
        "width": 2160
      },
      "fps": 25,
      "height": 4096,
      "isBinary": true,
      "mimetype": "video/mp4",
      "nb_frames": 969,
      "nb_streams": 1,
      "originalname": "pexels-cottonbro-5722113 (2160p).mp4",
      "refs": [],
      "size": 84263510,
      "startTime": 0,
      "taskStatusLog": [],
      "thumbnailId": "65950dd83dd3b675491ad343",
      "width": 2160
    }
  },
  "name": "pexels-cottonbro-5722113 (2160p).mp4",
  "creator": "user@dataloop.ai",
  "updatedAt": "2024-01-03T07:33:41.337Z",
  "updatedBy": "pipelines@dataloop.ai",
  "stream": "https://rc-gate.dataloop.ai/api/v1/items/65950dd53dd3b69ea61ad32b/stream",
  "thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/65950dd53dd3b69ea61ad32b/thumbnail",
  "annotations": [],
  "annotationsCount": 0,
  "annotated": false
}

JPG Format


{
  "id": "66cec643520f02585d37af68",
  "datasetId": "66cec624f37040beca7d3273",
  "url": "https://rc-gate.dataloop.ai/api/v1/items/66cec643520f02585d37af68",
  "dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/66cec624f37040beca7d3273",
  "createdAt": "2024-08-28T06:40:02.821Z",
  "dir": "/turtle",
  "filename": "/turtle/05e2720400.jpg",
  "type": "file",
  "hidden": false,
  "metadata": {
    "system": {
      "channels": 3,
      "encoding": "7bit",
      "height": 450,
      "isBinary": true,
      "mimetype": "image/jpeg",
      "originalname": "05e2720400.jpg",
      "refs": [],
      "size": 38747,
      "taskStatusLog": [],
      "thumbnailId": "66cec6559e5384504e9a633b",
      "width": 800
    }
  },
  "name": "05e2720400.jpg",
  "creator": "bot.b0b59f22-e9fc-484a-94f1-3e38313fadb4@bot.dataloop.ai",
  "updatedAt": "2024-08-28T06:40:21.703Z",
  "updatedBy": "user@dataloop.ai",
  "stream": "https://rc-gate.dataloop.ai/api/v1/items/66cec643520f02585d37af68/stream",
  "thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/66cec643520f02585d37af68/thumbnail",
  "annotations": [],
  "annotationsCount": 0,
  "annotated": false
}

TXT Format

{
  "id": "6746c0e1c80dc16a03dd5ede",
  "datasetId": "6746c0bc7e10823d1c9aefd5",
  "url": "https://rc-gate.dataloop.ai/api/v1/items/6746c0e1c80dc16a03dd5ede",
  "dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/6746c0bc7e10823d1c9aefd5",
  "createdAt": "2024-11-27T06:49:04.926Z",
  "dir": "/honeypot",
  "filename": "/honeypot/food_87.txt",
  "type": "file",
  "hidden": false,
  "metadata": {
    "system": {
      "document": {
        "source": "food_87.txt"
      },
      "encoding": "7bit",
      "isBinary": false,
      "mimetype": "text/plain",
      "originalname": "food_87.txt",
      "refs": [],
      "size": 2691,
      "tags": {
        "test": true
      },
      "taskStatusLog": []
    }
  },
  "name": "food_87.txt",
  "creator": "bot.b0b59f22-e9fc-484a-94f1-3e38313fadb4@bot.dataloop.ai",
  "updatedAt": "2025-01-20T13:00:37.038Z",
  "updatedBy": "rubiks@dataloop.ai",
  "stream": "https://rc-gate.dataloop.ai/api/v1/items/6746c0e1c80dc16a03dd5ede/stream",
  "thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/6746c0e1c80dc16a03dd5ede/thumbnail",
  "annotations": [],
  "annotationsCount": 0,
  "annotated": false
}

Dictionary Table

Key Name	Definition	Parent Key
id	Item/image ID	N/A
datasetId	Dataset ID	N/A
createdAt	Time and date the item/image was uploaded	N/A
dir	Image location directory in dataset	N/A
filename	Item/image full path	N/A
type	Item type	N/A
hidden	System property	N/A
metadata	This key holds all the item's information	N/A
system	This key holds all the item's system information	metadata
originalname	Original item's name when created	system
size	Image size in bytes	system
encoding	encoding	system
mimetype	Media type	system
taskStatusLog	List of item statuses in given tasks	system
status	Information about the status of the item in a given task	taskStatusLog
taskId	Task id	status
assignmentId	Assignment id	status
status	The status of the item in this task	status
creator	Creator of the status	status
timestamp	When the task status was created	status
action	The action (created/deleted) on the status of this item	taskStatusLog
refs	Task assignment list reference	system
type	task or assignment	refs
id	ID of the task/assignment that the item is linked with	refs
metadata	Information about the item in this task/assignment	refs
creator	Username of the creator of the status of the item in this task/assignment	metadata
status	Status of this item in this task/assignment – completed/discard/complete/custom status created by the task creator (this attribute will not show if no status has been created yet)	metadata
timestamp	Date and time when the status was created	metadata
isBinary	Is the item a binary file	system
executionLogs	Information about executions the item went through	system
image-preprocess	Information about preprocess the item went through (e.g., export metadata)	executionLogs
default-module	Name of the module	image-preprocess
on_create	Name of the function	default-module
61d5eb9da833ff954bdb16e4	Execution ID	on_create
status	Execution progress	61d5eb9da833ff954bdb16e4
progress	Execution status	61d5eb9da833ff954bdb16e4
pipeline-utils	FaaS name (as seen in application hub library)	executionLogs
default_module	App module name	pipeline-utils
move_to_task	Function name	default_module
61d5eb9da833ff1cabdb16fa	Execution of the move_to_task function	move_to_task
status	The status of the execution	61d5eb9da833ff1cabdb16fa
progress	The progress of the execution	61d5eb9da833ff1cabdb16fa
channels	Image color dimensions (1 black and white; 3 color (rgb); 4 with transparency effect)	system
exif	[exif](https://docs.dataloop.ai/docs/exif-orientation-value){target="_blank"} information	system
height	Image resolution	system
thumbnailAnnotationsId	Thumbnail Annotation id	system
thumbnailId	Thumbnail id	system
width	Image resolution	system
name	Updated item name	N/A
url	API URL for items	N/A
dataset	API URL for dataset	N/A
creator	Item creator	N/A
annotationsCount	Number of annotations	N/A
annotated	True shows that the item is annotated	N/A
stream	API URL for stream	N/A
thumbnail	API URL for thumbnail	N/A
annotations	Information about annotations	N/A

What's Next

GIS Item JSON Format

Table Of Contents

Item
Download an Item
Format Details
Dictionary Table