This page describes PDF annotation JSON, a data format for describing PDF data in JavaScript Object Notation (JSON). This JSON code includes the entity's data related to our software and its metadata.
PDF annotation JSON
{
"annotations": [
{
"id": "6763e0935c8f7b03c0b14bf9",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"url": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"createdAt": "2024-12-19T09:00:03.273Z",
"dir": "/",
"filename": "/PDF Annotations.pdf",
"type": "file",
"hidden": false,
"metadata": {
"system": {
"encoding": "7bit",
"isBinary": true,
"mimetype": "application/pdf",
"originalname": "PDF Annotations.pdf",
"refs": [
{
"id": "67b5b7f0a6f018425f8403cd",
"type": "assignment"
},
{
"id": "67b5b7f0a6f018d9ef8403cb",
"type": "task"
}
],
"size": 18020,
"taskStatusLog": []
}
},
"name": "PDF Annotations.pdf",
"creator": "user@gmail.com",
"updatedAt": "2024-12-19T09:00:03.371Z",
"updatedBy": "user@gmail.com",
"stream": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9/stream",
"thumbnail": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9/thumbnail",
"annotations": [
{
"id": "67cf29bc47ee8930050bed2f",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"itemId": "6763e0935c8f7b03c0b14bf9",
"url": "https://gate.dataloop.ai/api/v1/annotations/67cf29bc47ee8930050bed2f",
"item": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"type": "text_mark",
"label": "sentence-2",
"attributes": [],
"coordinates": "featuresofPDFdocumentsistheAnnotations—anumbrellatermthatcoversavarietyofinteractiveobjectsthatcanbeplacedontopofthePDFcontent.",
"metadata": {
"system": {
"attributes": {},
"automated": false,
"clientId": "9cd27efb-8062-407f-891f-59b9c1d09053",
"endFrame": 1,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "1",
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "6569aa2b27d7bdd0605b8fc9",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {
"highlight": {
"comment": {
"text": ""
},
"content": {
"text": "featuresofPDFdocumentsistheAnnotations—anumbrellatermthatcoversavarietyofinteractiveobjectsthatcanbeplacedontopofthePDFcontent."
},
"id": "sentence-2",
"position": {
"boundingRect": {
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 688.3746185302734,
"y1": 240.00869750976562,
"y2": 277.8211975097656
},
"pageNumber": 1,
"rects": [
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 688.3746185302734,
"y1": 240.00869750976562,
"y2": 257.2309265136719
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 521.1130218505859,
"y1": 260.5989685058594,
"y2": 277.8211975097656
}
]
}
},
"refs": [
{
"entity": "item",
"ref": "6763e0935c8f7b03c0b14bf9",
"refBy": "id",
"rel": "child"
}
]
}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T18:04:44.123Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T18:04:44.123Z",
"hash": "4e65f74b6295fe695953f47a677c355d3c4cf5cc",
"source": "ui",
"description": "featuresofPDFdocumentsistheAnnotations—anumbrellatermthatcoversavarietyofinteractiveobjectsthatcanbeplacedontopofthePDFcontent."
},
{
"id": "67cf29bc47ee8941790bed30",
"datasetId": "64b4d464bdf1fccfe1ba5790",
"itemId": "6763e0935c8f7b03c0b14bf9",
"url": "https://gate.dataloop.ai/api/v1/annotations/67cf29bc47ee8941790bed30",
"item": "https://gate.dataloop.ai/api/v1/items/6763e0935c8f7b03c0b14bf9",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64b4d464bdf1fccfe1ba5790",
"type": "text_mark",
"label": "paragraph-1",
"attributes": [],
"coordinates": "Intherealworld,theuseofPDFannotationsisvaried.Educatorsoftenusethemtoprovidefeedbackonstudents’work.Inbusiness,theyfacilitatecollaborativedocumentreview,enablingteammemberstoaddcomments,suggestions,orapprovals.Legalprofessionalsuseannotationstoreference",
"metadata": {
"system": {
"attributes": {
"1": "Yes"
},
"automated": false,
"clientId": "3cfb7221-2e7e-4e9b-b697-63c33e4d9192",
"endFrame": 1,
"endTime": 0,
"frame": 0,
"itemLinks": [],
"objectId": "2",
"openAnnotationVersion": "1.91.1-prod.3",
"recipeId": "6569aa2b27d7bdd0605b8fc9",
"snapshots_": [],
"startTime": 0,
"system": false
},
"user": {
"highlight": {
"comment": {
"text": ""
},
"content": {
"text": "Intherealworld,theuseofPDFannotationsisvaried.Educatorsoftenusethemtoprovidefeedbackonstudents’work.Inbusiness,theyfacilitatecollaborativedocumentreview,enablingteammemberstoaddcomments,suggestions,orapprovals.Legalprofessionalsuseannotationstoreference"
},
"id": "paragraph-1",
"position": {
"boundingRect": {
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 726.2897186279297,
"y1": 450.34722900390625,
"y2": 529.34033203125
},
"pageNumber": 1,
"rects": [
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 695.8234710693359,
"y1": 450.34722900390625,
"y2": 467.5694580078125
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 726.2897186279297,
"y1": 470.9375305175781,
"y2": 488.1597595214844
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 659.4998016357422,
"y1": 491.5278015136719,
"y2": 508.7500305175781
},
{
"height": 1074.1176470588234,
"pageNumber": 1,
"width": 829.9999999999999,
"x1": 97.63890075683594,
"x2": 259.66651916503906,
"y1": 512.1181030273438,
"y2": 529.34033203125
}
]
}
},
"refs": [
{
"entity": "item",
"ref": "6763e0935c8f7b03c0b14bf9",
"refBy": "id",
"rel": "child"
}
]
}
},
"creator": "user@dataloop.ai",
"createdAt": "2025-03-10T18:04:44.123Z",
"updatedBy": "user@dataloop.ai",
"updatedAt": "2025-03-10T18:04:44.123Z",
"hash": "19962b7b2750ecb30a279fb0bee82d461fd37d36",
"source": "ui",
"description": "Intherealworld,theuseofPDFannotationsisvaried.Educatorsoftenusethemtoprovidefeedbackonstudents’work.Inbusiness,theyfacilitatecollaborativedocumentreview,enablingteammemberstoaddcomments,suggestions,orapprovals.Legalprofessionalsuseannotationstoreference"
}
],
"annotationsCount": 2,
"annotated": true
}
]
}
Dictionary Table
| Key Name | Definition | Parent Key |
|---|---|---|
| id | Unique identifier for the item | Root |
| datasetId | Identifier for the dataset containing the item | Root |
| url | API URL to access the item | Root |
| dataset | API URL to access the dataset | Root |
| createdAt | Timestamp of when the item was created | Root |
| dir | Directory path of the item | Root |
| filename | File name of the item | 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 |
| system | System-related metadata | metadata |
| encoding | Encoding format of the file | system |
| isBinary | Boolean indicating if the file is binary | system |
| mimetype | MIME type of the file | system |
| originalname | Original name of the file | system |
| refs | List of references related to the file | system |
| id | Identifier of the reference | refs |
| type | Type of reference (e.g., task, assignment) | refs |
| size | Size of the file in bytes | system |
| taskStatusLog | Log of task statuses related to the item | system |
| name | Name of the item | Root |
| creator | Email of the user who created the item | Root |
| updatedAt | Timestamp of the last update | Root |
| updatedBy | Email of the user who updated the item | Root |
| stream | API URL to stream the item | Root |
| thumbnail | API URL to access the thumbnail | Root |
| annotations | List of annotations associated with the item | Root |
| id | Unique identifier for the annotation | annotations |
| datasetId | Identifier of the dataset associated with the annotation | annotations |
| itemId | Identifier of the item being annotated | annotations |
| url | API URL to access the annotation | annotations |
| item | API URL to access the annotated item | annotations |
| dataset | API URL to access the dataset of the annotation | annotations |
| type | Type of annotation (e.g., text_mark) | annotations |
| label | Label assigned to the annotation | annotations |
| attributes | List of attributes assigned to the annotation | annotations |
| coordinates | Coordinates of the text annotation | annotations |
| end | Ending position of the annotation in text | coordinates |
| label | Label associated with the annotation block | coordinates |
| start | Starting position of the annotation in text | coordinates |
| type | Type of annotation block | coordinates |
| metadata | Metadata related to the annotation | annotations |
| system | System metadata for annotation | metadata |
| attributes | Additional system attributes | system |
| automated | Boolean indicating if annotation was automated | system |
| clientId | Client ID associated with annotation | system |
| endFrame | End frame of the annotation | system |
| endTime | End time of the annotation | system |
| frame | Frame index of the annotation | system |
| itemLinks | Links to related annotation items | system |
| objectId | Object ID associated with the annotation | system |
| openAnnotationVersion | Version of annotation system | system |
| recipeId | Recipe identifier for annotation | system |
| snapshots_ | Snapshots related to the annotation | system |
| startTime | Start time of the annotation | system |
| system | Boolean indicating if annotation is system-generated | system |
| user | User-related metadata | metadata |
| creator | Email of the user who created the annotation | annotations |
| createdAt | Timestamp when annotation was created | annotations |
| updatedBy | Email of the user who updated the annotation | annotations |
| updatedAt | Timestamp when annotation was last updated | annotations |
| hash | Unique hash identifier for annotation | annotations |
| source | Source of the annotation (e.g., UI) | annotations |
| annotationsCount | Total count of annotations for the item | Root |
| annotated | Boolean indicating if the item has annotations | Root |