Labelbox data model reference

Data Row

A Data Row is the foundational unit to be labeled in Labelbox. A Data Row contains the Asset to be labeled (e.g. image or video), Annotations, and editor configurations such as Attachments.

Asset types

Assets are raw data that are labeled in the Labelbox Editor. An Asset may contain multiple images or hybrid data types. The Editor supports images, tiled imagery, videos, and text file asset types. Custom editors can support any asset type as long as it can be rendered in the browser.

Note

To see the JSON format for importing assets via the Python SDK, see our Python SDK tutorials section.

Image import

Supported formats:

  • PNG

  • JPG

Parameter

Required

Description

externalId

No

User-generated file name or ID for the file. For the best experience, this ID should be unique.

imageUrl

Yes

https path to an external image. For IAM Delegated Access, this URL must be in virtual-hosted-style format. For older regions, your S3 bucket may be in https://<bucket-name>.s3-<region>.amazonaws.com/<key> format. If your object URLs are formatted this way, make sure they are in virtual-hosted-style format before importing.

[ 
    { 
        "externalId": "2017-Tesla-Model-S-P90D-102.jpg", 
        "imageUrl": "https://storage.googleapis.com/labelbox-example-datasets/tesla/2017-Tesla-Model-S-P90D-102.jpg"
    }, 
    { 
        "externalId": "2017-Tesla-Model-3-top-view.jpg", 
        "imageUrl": "https://storage.googleapis.com/labelbox-example-datasets/tesla/2017-Tesla-Model-3-top-view.jpg"
    }
]
// URL format for IAM Delegated Access import

[
    {
        "externalId": "cells.jpg",
        "imageUrl": "https://lb-test-data.s3.us-west-1.amazonaws.com/cells.jpg"
    },
    {
        "externalId": "b17.jpg",
        "imageUrl": "https://lb-test-data.s3.us-west-1.amazonaws.com/B17.jpg"
    }
]

Video import

Supported format:

  • MP4 (H.264)

Note

Labelbox does not support videos with more than 20,000 frames.

Parameter

Required

Description

externalId

No

User-generated file name or ID for the file. For the best experience, this ID should be unique.

videoUrl

Yes

Accepts an https path to an external video. For IAM Delegated Access, this URL must be in virtual-hosted-style format. For older regions, your S3 bucket may be in https://<bucket-name>.s3-<region>.amazonaws.com/<key> format. If your object URLs are formatted this way, make sure they are in virtual-hosted-style format before importing.

[
    {
        "externalId": "google-cast.mp4",
        "videoUrl": "https://commondatastorage.googleapis.com/gtv-videos-bucket/CastVideos/dash/DesigningForGoogleCastVideo.mp4" 
    }, 
    { 
        "externalId": "bigger-blazes-video.mp4", 
        "videoUrl": "https://commondatastorage.googleapis.com/gtv-videos-bucket/CastVideos/dash/ForBiggerBlazesVideo.mp4" 
    }
]
// URL format for IAM Delegated Access import

[
    {
        "externalId": "case_video_000_001_12630-14430.mp4",
        "videoUrl": "https://lb-test-videos.s3.us-west-1.amazonaws.com/case_video_000_001_12630-14430.mp4"
    }
]

Text import

Supported formats:

  • https path to an external .txt file

Parameter

Required

Description

externalId

No

User-generated file name or ID for the file. For the best experience, this ID should be unique.

data

Yes

Accepts an https path to an external text file (emojis supported for cloud-hosted txt files). For IAM Delegated Access, this URL must be in virtual-hosted-style format. For older regions, your S3 bucket may be in https://<bucket-name>.s3-<region>.amazonaws.com/<key> format. If your object URLs are formatted this way, make sure they are in virtual-hosted-style format before importing.

[
    {
        "externalId": "lorem-ipsum.txt",
        "data": "https://storage.googleapis.com/labelbox-sample-datasets/nlp/lorem-ipsum.txt"
    }
]
// URL format for IAM Delegated Access import

[
    {
        "externalId": "plaintext+test.txt",
        "data": "https://lb-test-data.s3.us-west-1.amazonaws.com/plaintext+test.txt"
    }
]

Tiled imagery import

Supported formats:

  • Slippy map tiles in JPG or PNG

Parameter

Required

Description

tileLayerUrl

Yes

URL where map data is hosted. Must be in the following format: https://c.tile.openstreetmap.org/{z}/{x}/{y}.png

minZoom

Yes

Minimum map zoom level down to which this layer will be displayed (inclusive).

maxZoom

Yes

Maximum map zoom level up to which this layer will be displayed (inclusive).

maxNativeZoom

No

Maximum zoom number the tile source has available (maxNativeZoom & maxZoom). If specified, the tiles on all zoom levels higher than maxNativeZoom will be auto-scaled.

bounds

Yes

The bounds where the projection is valid. For the Simple coordinate system, bounds are in x,y. For the EPSG coordinate system, bounds are in lat,long.

epsg

Yes

Structured dataset of coordinate reference systems and coordinate transformations. Can be EPSG3857 or Simple.

alternativeLayers

No

Additional tile layers. Only alternativeLayers.tileLayerUrl and alternativeLayers.name are required. If no values for optional parameters are given, those values will default to the top-level keys.

version

No

Add version to your import to distinguish it from the legacy format. If version: 2 is present, Labelbox will perform the transform from bounds: [lng, lat] to bounds: [lat,lng] in the tile component and in the bounds restriction helper function for annotations. If version is absent, tiles will be imported in legacy format and you will not be able to load image tiles into the new Editor.

// Large imagery sample

[
    {
        "tileLayerUrl": "https://labelbox.s3-us-west-2.amazonaws.com/pathology/{z}/{x}/{y}.png",
        "minZoom": 1,
        "maxZoom": 8.5,
        "bounds": [
            [0, 0],
            [135, 128]
        ],
        "epsg": "Simple",
        "version": 2
    },
    {
        "tileLayerUrl": "https://s3-us-west-2.amazonaws.com/labelbox/tiler/efb292d2a04e/{z}/{x}/{y}.png",
        "minZoom": 5,
        "maxZoom": 8,
        "bounds": [
            [0, 0],
            [120, 130]
        ],
        "epsg": "Simple",
        "version": 2
    }
]
// Additional tile layers sample
[
     {
         "tileLayerUrl": "https://labelbox.s3-us-west-2.amazonaws.com/tiler/drone-map/rgb/{z}/{x}/{y}.png",
         "bounds": [
             [17.983835501492813,74.41417694091798],
             [17.996825561127697, 74.44644927978517]
         ],
         "minZoom": 8,
         "maxZoom": 22,
         "maxNativeZoom": 22,
         "epsg": "EPSG3857",
         "version": 2,
         "alternativeLayers": [
             {
                 "tileLayerUrl": "https://labelbox.s3-us-west-2.amazonaws.com/tiler/drone-map/ndvi/{z}/{x}/{y}.png",
                 "name": "NDVI"
             },
             {
                 "tileLayerUrl": "https://labelbox.s3-us-west-2.amazonaws.com/tiler/drone-map/dtm/{z}/{x}/{y}.png",
                 "name": "DTM"
             }
         ]
     }
]
// Map sections sample

[
    {
        "tileLayerUrl": "https://public-tiles.dronedeploy.com/1499994155_DANIELOPENPIPELINE_ortho_qfs/{z}/{x}/{y}.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9wdWJsaWMtdGlsZXMuZHJvbmVkZXBsb3kuY29tLzE0OTk5OTQxNTVfREFOSUVMT1BFTlBJUEVMSU5FX29ydGhvX3Fmcy8qIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoyMTQ1OTE0MTE4fX19XX0_&Signature=O~50rrGXdEC6Hi8jPJ3dbT~UtBd7Cw6iQPTxdJ8LU2IaoxeP22R3JpKPkLN3T3~Lcw3CyX7uft2Baj0MH93qUoCYyN~~jNX3OMkYV2jbrHDezf6zQRHAabXX-L2bL-JEGfFL6z3DWccOFeCH56CuhgC29k5CJx7I34P-LQJdnAUsA-KaqKH1IyYsHStRIfmMzdXNAWU58FTfqVljq9SbKXxfgdr2SZ~7VgLaZ8IhA0WnlKUo-JgqTd~jYa5mGCpR8351IMK0aMuY4Mld4SOXssQ-rOtlZtypvo8FDp474TlGIEGz5PHxGOPsqLPF19hEYTgoPqsUj8QEuiTfg-cmsg__&Key-Pair-Id=APKAJXGC45PGQXCMCXSA",
        "bounds": [
            [
                37.87488726890353,
                -122.32488870620728
            ],
            [
                37.87280390440759,
                -122.32154130935669
            ]
        ],
        "minZoom": 10,
        "maxZoom": 23,
        "epsg": "EPSG4326",
        "version": 2
    },
    {
        "tileLayerUrl": "https://public-tiles.dronedeploy.com/1499994155_DANIELOPENPIPELINE_ortho_qfs/{z}/{x}/{y}.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9wdWJsaWMtdGlsZXMuZHJvbmVkZXBsb3kuY29tLzE0OTk5OTQxNTVfREFOSUVMT1BFTlBJUEVMSU5FX29ydGhvX3Fmcy8qIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoyMTQ1OTE0MTE4fX19XX0_&Signature=O~50rrGXdEC6Hi8jPJ3dbT~UtBd7Cw6iQPTxdJ8LU2IaoxeP22R3JpKPkLN3T3~Lcw3CyX7uft2Baj0MH93qUoCYyN~~jNX3OMkYV2jbrHDezf6zQRHAabXX-L2bL-JEGfFL6z3DWccOFeCH56CuhgC29k5CJx7I34P-LQJdnAUsA-KaqKH1IyYsHStRIfmMzdXNAWU58FTfqVljq9SbKXxfgdr2SZ~7VgLaZ8IhA0WnlKUo-JgqTd~jYa5mGCpR8351IMK0aMuY4Mld4SOXssQ-rOtlZtypvo8FDp474TlGIEGz5PHxGOPsqLPF19hEYTgoPqsUj8QEuiTfg-cmsg__&Key-Pair-Id=APKAJXGC45PGQXCMCXSA",
        "bounds": [
            [
                37.8749042065848,
                -122.32149839401245
            ],
            [
                37.87278696624341,
                -122.31810808181763
            ]
        ],
        "minZoom": 10,
        "maxZoom": 23,
        "epsg": "EPSG4326",
        "version": 2
    },
    {
        "tileLayerUrl": "https://public-tiles.dronedeploy.com/1499994155_DANIELOPENPIPELINE_ortho_qfs/{z}/{x}/{y}.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9wdWJsaWMtdGlsZXMuZHJvbmVkZXBsb3kuY29tLzE0OTk5OTQxNTVfREFOSUVMT1BFTlBJUEVMSU5FX29ydGhvX3Fmcy8qIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoyMTQ1OTE0MTE4fX19XX0_&Signature=O~50rrGXdEC6Hi8jPJ3dbT~UtBd7Cw6iQPTxdJ8LU2IaoxeP22R3JpKPkLN3T3~Lcw3CyX7uft2Baj0MH93qUoCYyN~~jNX3OMkYV2jbrHDezf6zQRHAabXX-L2bL-JEGfFL6z3DWccOFeCH56CuhgC29k5CJx7I34P-LQJdnAUsA-KaqKH1IyYsHStRIfmMzdXNAWU58FTfqVljq9SbKXxfgdr2SZ~7VgLaZ8IhA0WnlKUo-JgqTd~jYa5mGCpR8351IMK0aMuY4Mld4SOXssQ-rOtlZtypvo8FDp474TlGIEGz5PHxGOPsqLPF19hEYTgoPqsUj8QEuiTfg-cmsg__&Key-Pair-Id=APKAJXGC45PGQXCMCXSA",
        "bounds": [
            [
                37.8749042065848,
                -122.31806516647339
            ],
            [
                37.87278696624341,
                -122.31529712677002
            ]
        ],
        "minZoom": 10,
        "maxZoom": 23,
        "epsg": "EPSG4326",
        "version": 2
    }
]

Attachments

Attachments are media you can attach to a Data Row to provide labelers with contextual information about the asset to be labeled. Attachments are supported for IAM Delegated Access imports.

Type: IMAGE

Parameter

Required

Description

attachments.type

Yes

Should be set to IMAGE.

attachments.value

Yes

Accepts an https URL to an external file.

Type: VIDEO

Parameter

Required

Description

attachments.type

Yes

Should be set to VIDEO.

attachments.value

Yes

Accepts an https path to an external file.

Type: TEXT

Parameter

Required

Description

attachments.type

Yes

Should be set to TEXT.

attachments.value

Yes

Accepts an https path to an external file OR a string of text. If you import a URL, it will display in the attachments section as a clickable hyperlink. Once a hyperlink is clicked, it will open a new tab in the browser and render the associated URL.

Type: IMAGE_OVERLAY

Displayed as additional image layers over a standard image asset in the Editor. Annotations on image layers not supported.

Parameter

Required

Description

attachments.type

Yes

Should be set to IMAGE_OVERLAY. Note: IMAGE_OVERLAY types can only be attached to image assets.

attachments.value

Yes

Accepts an https path to an external file.

[
     {
         "externalId": "basic.png",
         "imageUrl": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/basic.png",
         "attachments": [
             {
                 "type": "IMAGE",
                 "value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/disease_attachment.jpg"
             },
             {
                 "type": "VIDEO",
                 "value": "https://storage.googleapis.com/labelbox-sample-datasets/Videos/shibuya-1230-1530.mp4"
             },
             {
                 "type": "TEXT",
                 "value": "Some sample text"
            },
            {
                 "type": "IMAGE_OVERLAY",
                 "value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/rgb.png"
             }
         ]
     }
]
[
     {
         "externalId": "DesigningForGoogleCastVideo.mp4",
         "videoUrl": "https://commondatastorage.googleapis.com/gtv-videos-bucket/CastVideos/dash/DesigningForGoogleCastVideo.mp4",
         "attachments": [
             {
                 "type": "IMAGE",
                 "value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/disease_attachment.jpg"
             },
             {
                 "type": "VIDEO",
                 "value": "https://storage.googleapis.com/labelbox-sample-datasets/Videos/shibuya-1230-1530.mp4"
             },
             {
                 "type": "TEXT",
                 "value": "Some sample text"
            }
         ]
     }
]
[
     {
         "externalId": "lorem-ipsum.txt",
         "data": "https://storage.googleapis.com/labelbox-sample-datasets/nlp/lorem-ipsum.txt",
         "attachments": [
             {
                 "type": "IMAGE",
                 "value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/disease_attachment.jpg"
             },
             {
                 "type": "VIDEO",
                 "value": "https://storage.googleapis.com/labelbox-sample-datasets/Videos/shibuya-1230-1530.mp4"
             },
             {
                 "type": "TEXT",
                 "value": "Some sample text"
            }
         ]
     }
]
[
    {
        "externalId": "cklidhv7o0zdk0y4z4282dp6o",
        "tileLayerUrl": "https://s3-us-east-2.amazonaws.com/lb-ron/CACI/ron_mctiles/{z}/{x}/{y}.png",
        "bounds": [
            [
                19.405662413477728,
                -99.21052827588443
            ],
            [
                19.400498983095076,
                -99.20534818927473
            ]
        ],
        "minZoom": 12,
        "maxZoom": 20,
        "epsg": "EPSG4326",
        "version": 2,
        "attachments": [
             {
                 "type": "IMAGE",
                 "value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/disease_attachment.jpg"
             },
             {
                 "type": "VIDEO",
                 "value": "https://storage.googleapis.com/labelbox-sample-datasets/Videos/shibuya-1230-1530.mp4"
             },
             {
                 "type": "TEXT",
                 "value": "Some sample text"
            },
            {
                 "type": "IMAGE_OVERLAY",
                 "value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/rgb.png"
            }
        ]
    }
]

Annotations

An Annotation is a statement about a Data Row.

Segmentation mask

A segmentation mask is an Object-type annotation that labels pixels in an image.

Segmentation mask import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Yes

The ID of the Data Row where you want to attach the imported annotations.

mask.instanceURI

Image

Yes

Cloud-hosted mask (can be hosted on any cloud provider). If you are importing multiple mask annotations on a single Data Row, each mask should reference the same instanceURI. See example below.

mask.colorRGB

Image

Yes

An array of RGB values from 0 to 255 that indicates which color represents each given mask. Only 3-channel RGB colors are supported.

{
    "uuid": "45b15f9d-7884-4bb7-ac01-3567e8ed6c36",
    "schemaId": "ck68grts29n7w0890wv344dif",
    "dataRow": {
        "id": "cjxav5aa07r1g0dsq70t9eveg"
    },
    "mask": {
        "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuw2tq00053g68rbwjpoim?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0",
        "colorRGB": [
            255,
            255,
            255
        ]
    }
}{
    "uuid": "3a95ddcd-3ad0-4dc5-a24e-c05004b4b4d5",
    "schemaId": "ck7wi85rnd1050757aac5ba4d",
    "dataRow": {
        "id": "cjxav5aa07r1g0dsq70t9eveg"
    },
    "mask": {
        "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuw2tq00053g68rbwjpoim?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0",
        "colorRGB": [
            255,
            0,
            0
        ]
    }
}{
    "uuid": "f8284cbc-ecf3-4363-9e10-138501daf5f7",
    "schemaId": "ck7wi85pr1xz6079026yc0hch",
    "dataRow": {
        "id": "cjxav5aa07r1g0dsq70t9eveg"
    },
    "mask": {
        "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuw2tq00053g68rbwjpoim?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0",
        "colorRGB": [
            0,
            0,
            0
        ]
    }
}

Segmentation mask export

Parameter

Asset type

Description

schemaId

Image

The ID of the schema containing all of the information needed for rendering your annotation.

featureId

Image

ID of the annotation.

title

Image

Name of the annotation in the ontology.

color

Image

Color of the annotation in the ontology.

instanceURI

Image

Annotation information hosted on Labelbox servers.

{
    "featureId": "ck9bmetz800340za5k073bm7w",
    "schemaId": "ck9blmq1lnlxz08892qqlmxto",
    "title": "Orange bird",
    "value": "orange_bird",
    "color": "#2BFF00",
    "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuw2tq00053g68rbwjpoim?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0"
}

Point

A Point is an Object-type annotation that specifies a single coordinate point on an image or frame.

Point import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

point.x

Image

Tiled imagery

Yes

x-coordinate for the Point annotation. For Tiled imagery, this value is the longitude.

point.y

Image

Tiled imagery

Yes

y-coordinate for the Point annotation. For Tiled imagery, this value is the latitude.

{
    "uuid": "532953e6-746f-4d74-945d-b4a9c2786479",
    "schemaId": "ck68grts29n800890roip3u5d",
    "dataRow": {
         "id": "cjxav5aa07r1g0dsq70t9eveg"
     },
     "point": {
         "x": 30,
         "y": 150
     }
}
{
    "uuid": "532953e6-746f-4d74-945d-b4a9c2786479",
    "schemaId": "ck68grts29n800890roip3u5d",
    "dataRow": {
         "id": "cjxav5aa07r1g0dsq70t9eveg"
     },
     "point": {
         "x": 30,
         "y": 150
     }
}

Point export

Parameter

Asset type

Description

schemaId

Image

Video

Tiled imagery

The ID of the schema containing all of the information needed for rendering your annotation.

featureId

Image

Video

Tiled imagery

ID of the annotation.

title

Image

Video

Tiled imagery

Name of the annotation in the ontology.

color

Image

Video

Tiled imagery

Color of the annotation in the ontology.

point.x

Image

Video

x coordinate for Point annotation.

point.y

Image

Video

y coordinate for Point annotation.

instanceURI

Image

Annotation information hosted on Labelbox servers.

keyframe

Video

When keyframe is true, it means that a labeler created or made an adjustment to the annotation on that frame. When keyframe is false, it means the annotation was auto-populated or interpolated on that frame.

type

Tiled imagery

Annotation type

geometry.coordinates

Tiled imagery

Longitude and latitude, in that order.

{
    "featureId": "ck9bmemy91hic10bogwc6sygv",
    "schemaId": "ck9blmq1lnlxy0889stzln2ms",
    "title": "Bird eye",
    "value": "bird_eye",
    "color": "#D4FF00",
    "point": {
        "x": 116,
        "y": 98
    },
    "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuw0st00043g68jfguoplb?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0"
}
{
    "featureId": "ckmv0r56g00023g68s2dgru6l",
    "schemaId": "cklifp8jw0tn40y5p3xtr2kk2",
    "title": "right_ear",
    "value": "right_ear",
    "color": "#1CE6FF",
    "keyframe": true,
    "point": {
        "x": 943,
        "y": 500
}
{
    "featureId": "cknjemyt800073g68xh4fsxeu",
    "schemaId": "cknjemcpt0l4n0y92d3oo7no3",
    "title": "test3",
    "value": "test3",
    "color": "#FF4A46",
    "type": "point",
    "geometry": {
        "coordinates": [
            -99.20951155086122,
            19.404749976992253
        ]
    }
}

Bounding box

A Bounding box is an Object-type annotation that contains 4 coordinates on a rectangular border.

Bounding box import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

bbox.top

Image

Tiled imagery

Yes

Bounding box top-left corner y position.

bbox.left

Image

Tiled imagery

Yes

Bounding box top-left corner x position.

bbox.height

Image

Tiled imagery

Yes

Height of the bounding box in pixels.

bbox.width

Image

Tiled imagery

Yes

Width of the bounding box in pixels.

{
    "uuid": "efca0c21-5206-4da6-8cb5-d6ca43649cfa",
    "schemaId": "ck67grts29n7x0890atmeiahw",
    "dataRow": {
         "id": "cjxav4aa07r1g0dsq70t9eveg"
     },
     "bbox": {
         "top": 153,
         "left": 34,
         "height": 204,
         "width": 67
     }
}
{
    "uuid": "efca0c21-5206-4da6-8cb5-d6ca43649cfa",
    "schemaId": "ck67grts29n7x0890atmeiahw",
    "dataRow": {
         "id": "cjxav4aa07r1g0dsq70t9eveg"
     },
     "bbox": {
         "top": 153,
         "left": 34,
         "height": 204,
         "width": 67
     }
}

Bounding box export

Parameter

Asset type

Description

schemaId

Image

Video

Tiled imagery

The ID of the schema containing all of the information needed for rendering your annotation.

featureId

Image

Video

Tiled imagery

ID of the annotation.

title

Image

Video

Tiled imagery

Name of the annotation in the ontology.

color

Image

Video

Tiled imagery

Color of the annotation in the ontology.

bbox.top

Image

Video

y-coordinate of Bounding box top-left corner.

bbox.left

Image

Video

x-coordinate of Bounding box top-left corner.

bbox.height

Image

Video

Height of Bounding box in pixels.

bbox.width

Image

Video

Width of Bounding box in pixels.

instanceURI

Image

Annotation information hosted on Labelbox servers.

keyframe

Video

When keyframe is true, it means that a labeler created or made an adjustment to the annotation on that frame. When keyframe is false, it means the annotation was auto-populated or interpolated on that frame.

type

Tiled imagery

Annotation type. Value should by rectangle.

geometry.coordinates

Tiled imagery

Longitude and latitude, in that order.

{
    "featureId": "ck9bmeej61emf0yf5bgjb4tjw",
    "schemaId": "ck9blmq1lnlxw08895jy7zsk4",
    "title": "Blue bird",
    "value": "blue_bird",
    "color": "#FF8000",
    "bbox": {
        "top": 186,
        "left": 192,
        "height": 300,
        "width": 519
    },
    "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuvx6d00013g68f3g57xl8?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0"
}
{
    "featureId": "ck9bmeej61emf0yf5bgjb4tjw",
    "schemaId": "ck9blmq1lnlxw08895jy7zsk4",
    "title": "Car 1",
    "value": "car_1",
    "color": "#1CE6FF",
    "keyframe": false,
    "bbox": {
        "top": 1164,
        "left": 2538,
        "height": 222,
        "width": 119
    }
}
{
    "featureId": "ckossvopo00013h68phgicget",
    "schemaId": "ckosstz24fhch0yag6h6k6vem",
    "title": "bbox",
    "value": "bbox",
    "color": "#1CE6FF",
    "type": "rectangle",
    "geometry": {
        "coordinates": [
            [
                [
                    151.20171129670584,
                    -33.86658193385505
                ],
                [
                    151.20171129670584,
                    -33.86615404807865
                ],
                [
                    151.20256960353075,
                    -33.86615404807865
                ],
                [
                    151.20256960353075,
                    -33.86658193385505
                ],
                [
                    151.20171129670584,
                    -33.86658193385505
                ]
            ]
        ]
    }
}

Polygon

A Polygon is an Object-type annotation that contains a group of coordinates on a free-form polygon border.

Polygon import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

polygon.x

Image

Tiled imagery

Yes

x-coordinate for a single point on the Polygon annotation. For Tiled imagery, this value is the longitude.

polygon.y

Image

Tiled imagery

Yes

y-coordinate for a single point on the Polygon annotation. For Tiled imagery, this value is the latitude.

{
    "uuid": "1b5762e9-416c-44cf-9a5f-07effb51f863",
    "schemaId": "ck67grts29n7y0890q89jdcyp",
    "dataRow": {
        "id": "cjxav4aa07r1g0dsq70t9eveg"
    },
    "polygon": [
        {
            "x": 2,
            "y": 99
        },
        {
            "x": 93,
            "y": 5
        },
        {
            "x": 51,
            "y": 106
        },
        {
            "x": 176,
            "y": 142
        }
    ]
}
{
    "uuid": "1b5762e9-416c-44cf-9a5f-07effb51f863",
    "schemaId": "ck67grts29n7y0890q89jdcyp",
    "dataRow": {
        "id": "cjxav4aa07r1g0dsq70t9eveg"
    },
    "polygon": [
        {
            "x": 2,
            "y": 99
        },
        {
            "x": 93,
            "y": 5
        },
        {
            "x": 51,
            "y": 106
        },
        {
            "x": 176,
            "y": 142
        }
    ]
}

Polygon export

Parameter

Asset type

Description

schemaId

Image

Tiled imagery

The ID of the schema containing all of the information needed for rendering your annotation.

featureId

Image

Tiled imagery

ID of the annotation.

title

Image

Tiled imagery

Name of the annotation in the ontology.

color

Image

Tiled imagery

Color of the annotation in the ontology.

polygon.x

Image

x-coordinate for Point annotation. For Tiled imagery, this value is the longitude.

polygon.y

Image

y-coordinate for Point annotation. For Tiled imagery. this value is the latitude.

instanceURI

Image

Annotation information hosted on Labelbox servers.

type

Tiled imagery

Annotation type

geometry.coordinates

Tiled imagery

Longitude and latitude, in that order.

{
    "featureId": "ck9blnafk1d070yf5bhq4q1fv",
    "schemaId": "ck9blmq1lnlxv0889cu4r18mx",
    "title": "Black bird",
    "value": "black_bird",
    "color": "#006FA6",
    "polygon": [
        {
            "x": 3665.814,
            "y": 351.628
        },
        {
            "x": 3762.93,
            "y": 810.419
        },
        {
            "x": 3042.93,
            "y": 914.233
        },
        {
            "x": 2996.047,
            "y": 864
        },
        {
            "x": 3036.233,
            "y": 753.488
        }
    ],
    "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuwhfh00083g68sdwpwa04?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0"
}
{
    "featureId": "cknjekt1u00033g68rhvautuz",
    "schemaId": "cknjek2a80jic0y94dn8xgh5a",
    "title": "test2",
    "value": "test2",
    "color": "#FF34FF",
    "type": "polygon",
    "geometry": {
        "coordinates": [
            [
                [
                    -99.2086085262586,
                    19.402699145687013
                ],
                [
                    -99.20676074827523,
                    19.40271185664698
                ],
                [
                    -99.2069136106043,
                    19.40341371560633
                ],
                [
                    -99.20818859228417,
                    19.403328482715512
                ],
                [
                    -99.2086085262586,
                    19.402699145687013
                ]
            ]
        ]
    }
}

Polyline

A Polyline is an Object-type annotation that contains a series of points on a free-form line.

Polyline import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

line.x

Image

Tiled imagery

Yes

x-coordinate for a single point on the Polyline annotation.

line.y

Image

Tiled imagery

Yes

y-coordinate for a single point on the Polyline annotation.

{
    "uuid": "62e1d949-1c75-47f6-9ea2-e938da17d37c",
    "schemaId": "ck68grts29n7z08903nvgaim5",
    "dataRow": { 
        "id": "cjxav5aa07r1g0dsq70t9eveg" 
    }, 
    "line": [ 
        { 
            "x": 58, 
            "y": 148 
        }, 
        { 
            "x": 135, 
            "y": 79 
        }, 
        { 
            "x": 53, 
            "y": 191 
        } 
    ]
}
{
    "uuid": "62e1d949-1c75-47f6-9ea2-e938da17d37c",
    "schemaId": "ck68grts29n7z08903nvgaim5",
    "dataRow": { 
        "id": "cjxav5aa07r1g0dsq70t9eveg" 
    }, 
    "line": [ 
        { 
            "x": 58, 
            "y": 148 
        }, 
        { 
            "x": 135, 
            "y": 79 
        }, 
        { 
            "x": 53, 
            "y": 191 
        } 
    ]
}

Polyline export

Parameter

Asset type

Description

schemaId

Image

Tiled imagery

The ID of the schema containing all of the information needed for rendering your annotation.

featureId

Image

Tiled imagery

ID of the annotation.

title

Image

Tiled imagery

Name of the annotation in the ontology.

color

Image

Tiled imagery

Color of the annotation in the ontology.

line.x

Image

x coordinate for a single point on the Polyline annotation.

line.y

Image

y coordinate for a single point on the Polyline annotation.

instanceURI

Image

Annotation information hosted on Labelbox servers.

type

Tiled imagery

Annotation type. Value should be polyline.

geometry.coordinates

Tiled imagery

Longitude and latitude, in that order.

{
    "featureId": "ckmuuwb1p00073g68vg3t615r",
    "schemaId": "ckmuuvs5r5njc0y623c4s1dob",
    "title": "Tree branch",
    "value": "tree_branch",
    "color": "#008941",
    "line": [
        {
            "x": 198.027,
            "y": 1979.196
        },
        {
            "x": 321.472,
            "y": 1801.743
        },
        {
            "x": 465.491,
            "y": 1655.152
        }
    ],
    "instanceURI": "https://api.labelbox.com/masks/feature/ckmuuwb1p00073g68vg3t615r?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3MDM4NDAwLCJleHAiOjE2MTk2MzA0MDB9.5YaORL6mWpPqgAb6IbWChm4MQo14obOU8LFWbfCEHR0"
}
{
    "featureId": "ckossvrll00033h68tczgb8p9",
    "schemaId": "ckosstz24fhci0yag63j377hz",
    "title": "line",
    "value": "line",
    "color": "#FF34FF",
    "type": "polyline",
    "geometry": {
        "coordinates": [
            [
                151.20330452874953,
                -33.866105019363175
            ],
            [
                151.20364785147953,
                -33.866737933344254
            ]
        ]
    }
}

Entity

An Entity is an Object-type annotation used for labeling characters in unstructured text files.

Entity import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Text file

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Text file

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Text file

Yes

The ID of the Data Row where you want to attach the imported annotations.

location.start

Text file

Yes

The index of the first character in the Entity annotation. Assumes start-index inclusion.

location.end

Text file

Yes

The index of the last character in the Entity annotation. Assumes end-index exclusion (character 128 in the example below would be excluded from the Entity annotation).

{ 
    "uuid": "9fd9a92e-2560-4e77-81d4-b2e955800092", 
    "schemaId": "ck8kukafkqx1a0880iczbrqym",
    "dataRow": { 
        "id": "ck1s02fqxm8fi0757f0e6qtdc" 
    }, 
    "location": { 
        "start": 67, 
        "end": 128 
    }
}

Entity export

Parameter

Asset type

Description

schemaId

Text file

The ID of the schema containing all of the information needed for rendering your annotation.

featureId

Text file

ID of the annotation.

title

Text file

Name of the annotation in the ontology.

color

Text file

Color of the annotation in the ontology.

version

Text file

Export format version.

format

Text file

Export format specification.

data.location.start

Text file

The index of the first character in the Entity annotation. Assumes start-index inclusion.

data.location.end

Text file

The index of the last character in the Entity annotation. Assumes end-index exclusion.

{
    "featureId": "ck8kulppv000x0yf8pqpqqin4",
    "schemaId": "ck8kukafkqx1a0880iczbrqym",
    "title": "Entity type A",
    "value": "entity_type_a",
    "color": "#8000FF",
    "version": 1,
    "format": "text.location",
    "data": {
        "location": {
            "start": 67,
            "end": 128
        }
    }
}

Radio

A Radio is a Classification-type annotation. A Radio accepts only one correct response.

Radio classifications can be applied at the global level and can be nested within an object-type annotation. Nested classifications are supported for all data types except video.

Radio import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Video

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Video

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Video

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

answer.schemaId

Image

Video

Tiled imagery

Yes

The ID of the radio answer schema. Radio can only have one correct answer so "answer" is singular.

frames.start

Video

Yes

The first frame you wish to include in the radio classification.

frames.end

Video

Yes

The last frame you wish to include in the radio classification.

{
    "uuid": "1278daa6-ce64-4363-be24-4fa5eadffb17",
    "dataRow": {
        "id": "ckd11jg6scq9c0cq43vmh6i07"
    },  
    "schemaId": "ckd11j3yk000c0z0u4xn6dc4r", // Radio question
    "answer": {
        "schemaId": "ckd11j415000u0z0ubu7ee4w2" // Radio answer
    }
}
{
   "schemaId": "ckd1295hc00640z0uapvm1xbd",  // question schema id
   "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
   "dataRow": {
       "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "answer": {
        "schemaId": "ckd1295jn00760z0u01hw4yz5" // answer schema id
    },
    "frames": [
        {
            "start": 7,
            "end": 13,
        },
        {
            "start": 18,
            "end": 19,
        }
    ]
}
{
    "uuid": "1278daa6-ce64-4363-be24-4fa5eadffb17",
    "dataRow": {
        "id": "ckd11jg6scq9c0cq43vmh6i07"
    },  
    "schemaId": "ckd11j3yk000c0z0u4xn6dc4r", // Radio question
    "answer": {
        "schemaId": "ckd11j415000u0z0ubu7ee4w2" // Radio answer
    }
}

Radio export

Parameter

Asset type

Description

featureId

Image

Video

Text file

Tiled imagery

ID of the classification question in the ontology.

schemaId

Image

Video

Text file

Tiled imagery

ID of the schema that contains all of the structural information for the classification question.

title

Image

Video

Text file

Tiled imagery

Text that appears as the classification question.

value

Image

Video

Text file

Tiled imagery

Name of the classification question in the Labelbox database.

answer.featureId

Image

Video

Text file

Tiled imagery

ID of the classification answer in the ontology.

answer.schemaId

Image

Video

Text file

Tiled imagery

ID of the schema that contains the structural information for the classification answer.

answer.title

Image

Video

Text file

Tiled imagery

Text that appears as the classification answer.

answer.value

Image

Video

Text file

Tiled imagery

Name of the classification answer in the Labelbox database.

answer.keyframe

Video

When keyframe is true, it means that a labeler created or made an adjustment to the annotation on that frame. When keyframe is false, it means the annotation was auto-populated or interpolated on that frame.

{
    "featureId": "ckmuuwmp4000a3g68rmku827s",
    "schemaId": "ckmuuvs5p5nj40y629l1570bi",
    "title": "Is it daytime?",
    "value": "is_it_daytime?",
    "answer": {
        "featureId": "ckmuuwmp400093g68qof3hnt8",
        "schemaId": "ckmuuvs7u5njg0y629iiuc216",
        "title": "Yes",
        "value": "yes"
    }
}
{
    "featureId": "cknp365y41fk60y9y7nz7faqt",
    "schemaId": "ckmvaijzd2elz0y8h06ribh9b",
    "title": "Is it daytime?",
    "value": "is_it_daytime?",
    "answer": {
        "featureId": "cknp365y41fka0y9ydabe7be4",
        "schemaId": "ckmvaik0p2eml0y8h12z632kq",
        "title": "Yes",
        "value": "yes",
        "keyframe": false
    }
}
{
    "featureId": "cknp3d0hw00013g68wkjemi6o",
    "schemaId": "cknp3ctst06nq0ycte8icc2l3",
    "title": "Is it daytime?",
    "value": "is_it_daytime?",
    "answer": {
        "featureId": "cknp3d0hw00003g685c0nj5c1",
        "schemaId": "cknp3cttx06oe0yct3f0d6pmz",
        "title": "Yes",
        "value": "yes"
    }
}
{
    "featureId": "cknp3d0hw00013g68wkjemi6o",
    "schemaId": "cknp3ctst06nq0ycte8icc2l3",
    "title": "Is it daytime?",
    "value": "is_it_daytime?",
    "answer": {
        "featureId": "cknp3d0hw00003g685c0nj5c1",
        "schemaId": "cknp3cttx06oe0yct3f0d6pmz",
        "title": "Yes",
        "value": "yes"
    }
}

Checklist

Checklist is a Classification-type annotation. Checklist classifications accept more than one correct answer.

Checklist classifications can be applied at the global level and can be nested within an object-type annotation. Nested classifications are supported for all data types except video.

Checklist import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Video

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Video

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Video

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

answers.schemaId

Image

Video

Tiled imagery

Yes

The ID of the Checklist answer schema. Checklist can have multiple correct answers so "answers" is plural.

frames.start

Video

Yes

The first frame you wish to include in the checklist classification.

frames.end

Video

Yes

The last frame you wish to include in the checklist classification.

{
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
        "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "schemaId": "ckd1295hc00640z0uapvm1xbd", // Checklist question
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
        },
        {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
        }
    ]
}
{
    "schemaId": "ckd1295hc00640z0uapvm1xbd",  // question schema id
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
    "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // answer schema id
        }, {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // answer schema id
        }
    ],
    "frames": [
        {
            "start": 7,
            "end": 13,
        },
        {
            "start": 18,
            "end": 19,
        }
    ]
}
{
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
        "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "schemaId": "ckd1295hc00640z0uapvm1xbd", // Checklist question
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
        },
        {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
        }
    ]
}

Checklist export

Parameter

Asset type

Description

featureId

Image

Video

Text file

Tiled imagery

ID of the classification question in the ontology.

schemaId

Image

Video

Text file

Tiled imagery

ID of the schema that contains all of the structural information for the classification question.

title

Image

Video

Text file

Tiled imagery

Text that appears as the classification question.

value

Image

Video

Text file

Tiled imagery

Name of the classification question in the Labelbox database.

answers.featureId

Image

Video

Text file

Tiled imagery

ID of the classification answer in the ontology.

answers.schemaId

Image

Video

Text file

Tiled imagery

ID of the schema that contains the structural information for the classification answer.

answers.title

Image

Video

Text file

Tiled imagery

Text that appears as the classification answer.

answers.value

Image

Video

Text file

Tiled imagery

Name of the classification answer in the Labelbox database.

answers.keyframe

Video

When keyframe is true, it means that a labeler created or made an adjustment to the annotation on that frame. When keyframe is false, it means the annotation was auto-populated or interpolated on that frame.

{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}
{
    "featureId": "cknp36ay800003g68b908p4ah",
    "schemaId": "cknp35stw05w90yct45j4c7h6",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "cknp36ay800013g685e5ztvmp",
            "schemaId": "cknp35svp05x10yct13lv37rl",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer",
            "keyframe": true
        },
        {
            "featureId": "cknp36bdt00023g68zylk8kwx",
            "schemaId": "cknp35svp05x30yct898ga2pq",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer",
            "keyframe": false
        }
    ]
}
{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}
{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}

Free-form text

Free-form text is a Classification-type annotation that allows the labeler to type the response to the question.

Free-form classifications can be applied at the global level and can be nested within an object-type annotation.

Note

Not supported:

  • Using Free-form text classification to label video data

Free-form text import

Import format for Model-assisted labeling workflow.

Parameter

Asset type

Required

Description

uuid

Image

Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image

Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image

Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

answer

Image

Tiled imagery

Yes

Correct answer for the free-form text classification.

{
    "uuid": "4f1fe322-7b80-49a1-81cb-5914404df378",
    "dataRow": {
        "id": "ckd1299m8cqck0cq42lsz5khc"
    },
    "schemaId": "ckd1295hg006c0z0u6x41hx0d",
    "answer": "<correct_text_answer>"
}
{
    "uuid": "4f1fe322-7b80-49a1-81cb-5914404df378",
    "dataRow": {
        "id": "ckd1299m8cqck0cq42lsz5khc"
    },
    "schemaId": "ckd1295hg006c0z0u6x41hx0d",
    "answer": "<correct_text_answer>"
}

Free-form text export

Parameter

Asset type

Description

featureId

Image

Text file

Tiled imagery

ID of the classification question in the ontology.

schemaId

Image

Text file

Tiled imagery

ID of the schema that contains all of the structural information for the classification question.

title

Image

Text file

Tiled imagery

Text that appears as the classification question.

value

Image

Text file

Tiled imagery

Name of the classification question in the Labelbox database.

answer

Image

Text file

Tiled imagery

Correct answer for the free-form text classification.

{
    "featureId": "ckmuzkkhw000a3g68xegct9wz",
    "schemaId": "ckmuzjtfa64bq0y839bn8ci4l",
    "title": "Free-form text",
    "value": "free-form_text",
    "answer": "Correct text answer"
}
{
    "featureId": "cknp3dugp00073g68fkudn092",
    "schemaId": "cknp3ctsu06nu0yctf0v5gzij",
    "title": "Free-form text",
    "value": "free-form_text",
    "answer": "Correct text answer"
}
{
    "featureId": "cknp3dugp00073g68fkudn092",
    "schemaId": "cknp3ctsu06nu0yctf0v5gzij",
    "title": "Free-form text",
    "value": "free-form_text",
    "answer": "Correct text answer"
}

Dropdown

Dropdown is a Classification-type annotation. A Dropdown classification can have nested answers.

Note

Not supported:

  • Importing Dropdown classifications via Model-assisted labeling (MAL)

  • Using Dropdown classifications for labeling video data.

Dropdown export

Parameter

Asset type

Description

featureId

Image

Text file

Tiled imagery

ID of the classification question in the ontology.

schemaId

Image

Text file

Tiled imagery

ID of the schema that contains all of the structural information for the classification question.

title

Image

Text file

Tiled imagery

Text that appears as the classification question.

value

Image

Text file

Tiled imagery

Name of the classification question in the Labelbox database.

answer.featureId

Image

Text file

Tiled imagery

ID of the classification answer in the ontology.

answer.schemaId

Image

Text file

Tiled imagery

ID of the schema that contains the structural information for the classification answer.

answer.title

Image

Text file

Tiled imagery

Text that appears as the classification answer.

answer.value

Image

Text file

Tiled imagery

Name of the classification answer in the Labelbox database.

{
    "featureId": "ckmuzkf8500093g68kldgqhnw",
    "schemaId": "ckmuzjtfa64bs0y8390ugdxnc",
    "title": "Dropdown classification",
    "value": "dropdown_classification",
    "answer": [
        {
            "featureId": "ckmuzkf8500073g681cm8eh4v",
            "schemaId": "ckmuzjtlx64c30y8306gcc1qb",
            "title": "Dropdown answer 1",
            "value": "dropdown_answer_1"
        },
        {
            "featureId": "ckmuzkf8500083g68jfsezpil",
            "schemaId": "ckmuzjtnh64cb0y8314sl6rjj",
            "title": "Dropdown answer 1B",
            "value": "dropdown_answer_1b"
        }
    ]
}
{
    "featureId": "cknp3dn4d00063g68xq9dp7fq",
    "schemaId": "cknp3ctsv06nw0yct4yo74buz",
    "title": "Dropdown",
    "value": "dropdown",
    "answer": [
        {
            "featureId": "cknp3dn4d00043g682r6h1l6b",
            "schemaId": "cknp3cttw06oa0yctg4an5il0",
            "title": "1",
            "value": "1"
        },
        {
            "featureId": "cknp3dn4d00053g68ec0frwns",
            "schemaId": "cknp3ctun06oi0ycthtts5l2y",
            "title": "1a",
            "value": "1a"
        }
    ]
}
{
    "featureId": "cknp3dn4d00063g68xq9dp7fq",
    "schemaId": "cknp3ctsv06nw0yct4yo74buz",
    "title": "Dropdown",
    "value": "dropdown",
    "answer": [
        {
            "featureId": "cknp3dn4d00043g682r6h1l6b",
            "schemaId": "cknp3cttw06oa0yctg4an5il0",
            "title": "1",
            "value": "1"
        },
        {
            "featureId": "cknp3dn4d00053g68ec0frwns",
            "schemaId": "cknp3ctun06oi0ycthtts5l2y",
            "title": "1a",
            "value": "1a"
        }
    ]
}

Label (Annotation set)

A Label is a logical group of Annotations on an Asset. The Label export is a JSON payload object that contains all of the following information. The following describes Label version 1.

Key

Description

ID

Label ID.

DataRow ID

ID of the Data Row.

Labeled Data

URL to the Asset that was labeled.

Label.frames

URL to the video frame annotations.

Label.frameNumber

(VIDEO ONLY) Frame number where the annotation is located.

Label.objects

An array of the Object-type annotations. If there are no Object-type annotations in the Label, the array will be empty. The Object-type annotations are Bounding box, Segmentation mask, Polygon, Point, Polyline, and Text entity. See Annotations section.

Label.classifications

An array of Classification-type annotations at the global level. Classification-type annotations are Radio, Checklist, Free-form text, and Dropdown. See Annotations section.

Created At

Timestamp indicating when the Label was created.

Updated At

Timestamp indicating when the Label was updated. If the Label has not been updated since it was created, the timestamp will match the Created At timestamp.

Seconds to Label

Number of seconds taken to create the Label.

External ID

User-generated filename or ID for the Data Row.

Agreement

Consensus agreement score.

Benchmark Agreement

Benchmark agreement score.

Benchmark ID

ID of the Benchmark if enabled for this project.

Dataset Name

Name of the Dataset containing the Data Row.

Reviews.score

1 indicates a Reviewer approved the Label. -1 indicates a Reviewer rejected the Label.

Reviews.id

ID of the Label review.

Reviews.createdAt

Timestamp indicating when the Label was reviewed.

Reviews.createdBy

Member that reviewed the Label.

View Label

Link to open the Asset (and Annotations) in the Editor.

Has Open Issues

Indicates whether the Label has any issues that need to be addressed.

[
    {
        "ID": "ckn95nnx000073g68fufpnw7a",
        "DataRow ID": "ckn93aswv1nfw0rfz18rq00mt",
        "Labeled Data": "https://storage.labelbox.com/ck2yve0h0005b07274s4f0v02%2Fca0697fd-a922-a004-3dfd-4c572921ab2a-eva-waardenburg-v-3NQ3pmWkY-unsplash.jpg?Expires=1598717540394&KeyName=labelbox-assets-key-1&Signature=ozyDhfwJNhP_Yijj4rZIan05nS8",
        "Label": {
            "objects": [
                {
                    "featureId": "ckn94on8s00013g68cgjl632a",
                    "schemaId": "ckn94hhay0opt0y6993fb64bl",
                    "title": "Sample object 1",
                    "value": "sample_object_1",
                    "color": "#ffb31c",
                    "bbox": {
                        "top": 1099,
                        "left": 2010,
                        "height": 690,
                        "width": 591
                    },
                    "instanceURI": "https://api.labelbox.com/masks/feature/ckn94on8s00013g68cgjl632a?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3OTAzMDU5LCJleHAiOjE2MjA0OTUwNTl9.r6Qw2Qx_wbtflEwnZm-7XzPP-AbZn5VuIQ4_ETjBqJc"
                },
                {
                    "featureId": "ckn94pfs700033g68hidmdqsg",
                    "schemaId": "ckn94hhay0opv0y69fbpg76bs",
                    "title": "Sample object 2",
                    "value": "sample_object_2",
                    "color": "#FF34FF",
                    "instanceURI": "https://api.labelbox.com/masks/feature/ckn94pfs700033g68hidmdqsg?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE3OTAzMDU5LCJleHAiOjE2MjA0OTUwNTl9.r6Qw2Qx_wbtflEwnZm-7XzPP-AbZn5VuIQ4_ETjBqJc"
                }
            ],
            "classifications": [
                {
                    "featureId": "ckn95n44p00063g682vrko4pp",
                    "schemaId": "ckn94hhax0opr0y6936u2db78",
                    "title": "Is it daytime?",
                    "value": "is_it_daytime?",
                    "answer": {
                        "featureId": "ckn95n44o00053g68a1dckji7",
                        "schemaId": "ckn94hhbn0opx0y69bwh6b3je",
                        "title": "yes",
                        "value": "yes"
                    }
                }
            ]
        },
        "Created By": "alexandra+1@labelbox.com",
        "Project Name": "Beginner tutorial project",
        "Created At": "2021-04-08T17:29:33.000Z",
        "Updated At": "2021-04-08T17:30:34.000Z",
        "Seconds to Label": 149.852,
        "External ID": "layers-testing",
        "Agreement": -1,
        "Benchmark Agreement": -1,
        "Benchmark ID": null,
        "Dataset Name": "image-layers-sample.json",
        "Reviews": [],
        "View Label": "https://editor.labelbox.com?project=ckn889kbvt35m0789527t5rr5&label=ckn95nnx000073g68fufpnw7a",
        "Has Open Issues": 0
    }
]
[
    {
        "ID": "cknp36mns00033g68sqqsq844",
        "DataRow ID": "cklifdz2e1yf10rco407yaita",
        "Labeled Data": "https://storage.labelbox.com/ck52rvx0mpw4g0766wgqvjtl9%2F98c62818-8aad-2da8-aa86-141fb32742f4-lioness_walking.mp4?Expires=1620075890645&KeyName=labelbox-assets-key-3&Signature=Es1jENXKqKPt4nShF89ASvVmLzE",
        "Label": {
            "frames": "https://api.labelbox.com/v1/frames/cknp36mns00033g68sqqsq844"
        },
        "Created By": "alexandra+1@labelbox.com",
        "Project Name": "Lioness walking",
        "Created At": "2021-04-19T21:04:38.000Z",
        "Updated At": "2021-04-19T21:04:45.000Z",
        "Seconds to Label": 20,
        "External ID": "lioness_walking.mp4",
        "Agreement": -1,
        "Benchmark Agreement": -1,
        "Benchmark ID": null,
        "Dataset Name": "lioness_walking",
        "Reviews": [],
        "View Label": "https://editor.labelbox.com?project=cklifeflvf7dx0795p3rzpa6g&label=cknp36mns00033g68sqqsq844",
        "Has Open Issues": 0
    }
]
// Access per-frame annotation info via Label.frames URL (see above)
{
    "frameNumber": 1,
    "classifications": [
        {
            "featureId": "ckmvaolhj2f2p0y8h7it0gpb2",
            "schemaId": "ckmvaijzd2elz0y8h06ribh9b",
            "title": "Is it daytime?",
            "value": "is_it_daytime?",
            "answer": {
                "featureId": "ckmvaq6p3000c3g68vlqkjo18",
                "schemaId": "ckmvaik0p2eml0y8h12z632kq",
                "title": "Yes",
                "value": "yes",
                "keyframe": true
            }
        }
    ],
    "objects": [
        {
            "featureId": "ckmvapiqw00083g688yjpvd34",
            "schemaId": "cklifp8jw0tn40y5p3xtr2kk2",
            "title": "right_ear",
            "value": "right_ear",
            "color": "#1CE6FF",
            "keyframe": true,
            "point": {
                "x": 1447,
                "y": 430
            },
            "classifications": [
                {
                    "featureId": "ckmvaplfj00093g68elakf0q2",
                    "schemaId": "cklifp8ly0tnu0y5pd2jrcams",
                    "title": "Visibility",
                    "value": "visibility",
                    "answer": {
                        "featureId": "ckmvaplfj000a3g68rax7qw9k",
                        "schemaId": "cklifp8n20to80y5p6pyo0jyu",
                        "title": "0",
                        "value": "0",
                        "keyframe": true
                    }
                }
            ]
        },
        {
            "featureId": "ckmvaqsco000g3g681txq5v8h",
            "schemaId": "ckmvaobyl20s70y8u13eu6nmc",
            "title": "Lion",
            "value": "lion",
            "color": "#997D87",
            "keyframe": true,
            "bbox": {
                "top": 366,
                "left": 557,
                "height": 571,
                "width": 977
            },
            "classifications": [
                {
                    "featureId": "ckmvaqvbc000h3g68i6d37w8y",
                    "schemaId": "ckmvaoc0120si0y8uang3hwza",
                    "title": "Is the lion walking?",
                    "value": "is_the_lion_walking?",
                    "answer": {
                        "featureId": "ckmvaqvbd000i3g68z4c3i78s",
                        "schemaId": "ckmvaoc1s20tb0y8ub1p79fl8",
                        "title": "No",
                        "value": "no",
                        "keyframe": true
                    }
                }
            ]
        }
    ]
}
[
    {
        "ID": "cknp3dwk4000b3g68ghqpti7y",
        "DataRow ID": "ckekrwg3zqjbo0bs3hl15ex1i",
        "Labeled Data": "https://storage.googleapis.com/labelbox-sample-datasets/nlp/lorem-ipsum.txt",
        "Label": {
            "objects": [
                {
                    "featureId": "cknp3dvhg000a3g68hujtu6l1",
                    "schemaId": "ckkd4yl0e0le30ycl7i4944l5",
                    "title": "A",
                    "value": "a",
                    "color": "#1CE6FF",
                    "version": 1,
                    "format": "text.location",
                    "data": {
                        "location": {
                            "start": 6,
                            "end": 145
                        }
                    },
                    "instanceURI": "https://api.labelbox.com/masks/feature/cknp3dvhg000a3g68hujtu6l1?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjazUycnZ4MWtxYXpiMDc3MDBtcTI3eDRsIiwib3JnYW5pemF0aW9uSWQiOiJjazUycnZ4MG1wdzRnMDc2NndncXZqdGw5IiwiaWF0IjoxNjE4ODY2NjI4LCJleHAiOjE2MjE0NTg2Mjh9.tW78CH7C7Nb85w6epSULEpaY4sEg6UeWeSk0WmCP5jg"
                }
            ],
            "classifications": [
                {
                    "featureId": "cknp3d0hw00013g68wkjemi6o",
                    "schemaId": "cknp3ctst06nq0ycte8icc2l3",
                    "title": "Radio",
                    "value": "radio",
                    "answer": {
                        "featureId": "cknp3d0hw00003g685c0nj5c1",
                        "schemaId": "cknp3cttx06oe0yct3f0d6pmz",
                        "title": "Yes",
                        "value": "yes"
                    }
                },
                {
                    "featureId": "cknp3dk5r00013g68lyduuwvp",
                    "schemaId": "cknp3dfo51h900y9y5j10g7hg",
                    "title": "Checklist",
                    "value": "checklist",
                    "answers": [
                        {
                            "featureId": "cknp3dk5r00003g6864se47ef",
                            "schemaId": "cknp3dfv21h9a0y9yagz41wtq",
                            "title": "1",
                            "value": "1"
                        },
                        {
                            "featureId": "cknp3dko500033g685s10zw9u",
                            "schemaId": "cknp3dfv21h9b0y9yg34i8xru",
                            "title": "2",
                            "value": "2"
                        }
                    ]
                }
            ]
        },
        "Created By": "alexandra+1@labelbox.com",
        "Project Name": "NER",
        "Created At": "2021-04-19T21:10:17.000Z",
        "Updated At": "2021-04-19T21:10:18.000Z",
        "Seconds to Label": 28.293,
        "External ID": null,
        "Agreement": -1,
        "Benchmark Agreement": -1,
        "Benchmark ID": null,
        "Dataset Name": "Lorem ipsum.txt",
        "Reviews": [],
        "View Label": "https://editor.labelbox.com?project=ckkd4xstjqnsb0740zwio6grd&label=cknp3dwk4000b3g68ghqpti7y",
        "Has Open Issues": 0
    }
]
[   
    {
        "ID": "cknjenzdz000j3g68m4m0si3n",
        "DataRow ID": "cknje9wzy3zjo0ysiaxbqcpmn",
        "Labeled Data": "{\"tileLayerUrl\":\"https://s3-us-east-2.amazonaws.com/lb-ron/CACI/ron_mctiles/{z}/{x}/{y}.png\",\"bounds\":[[19.37468183118193,-99.21052827588443],[19.36951840079928,-99.20534818927473]],\"minZoom\":12,\"maxZoom\":20,\"epsg\":\"EPSG4326\",\"alternativeLayers\":[{\"tileLayerUrl\":\"https://api.mapbox.com/styles/v1/mapbox/satellite-streets-v11/tiles/{z}/{x}/{y}?access_token=pk.eyJ1IjoibWFwYm94IiwiYSI6ImNpejY4NXVycTA2emYycXBndHRqcmZ3N3gifQ.rJcFIG214AriISLbB6B5aw\",\"name\":\"Satellite\"},{\"tileLayerUrl\":\"https://api.mapbox.com/styles/v1/mapbox/navigation-guidance-night-v4/tiles/{z}/{x}/{y}?access_token=pk.eyJ1IjoibWFwYm94IiwiYSI6ImNpejY4NXVycTA2emYycXBndHRqcmZ3N3gifQ.rJcFIG214AriISLbB6B5aw\",\"name\":\"Guidance\"}]}",
        "Label": {
            "objects": [
                {
                    "featureId": "cknjen3yk000b3g68nkz6ykfs",
                    "schemaId": "cknjek2a80jia0y943yo56ken",
                    "title": "test1",
                    "value": "test1",
                    "color": "#1CE6FF",
                    "type": "polygon",
                    "geometry": {
                        "coordinates": [
                            [
                                [
                                    -99.20909603539366,
                                    19.372026698005648
                                ],
                                [
                                    -99.20786968446487,
                                    19.37236831548407
                                ],
                                [
                                    -99.20868616690551,
                                    19.373114634814314
                                ],
                                [
                                    -99.20909603539366,
                                    19.372026698005648
                                ]
                            ]
                        ]
                    }
                },
                {
                    "featureId": "cknjenq3c000c3g68lpyqvwtk",
                    "schemaId": "cknjek2a80jic0y94dn8xgh5a",
                    "title": "test2",
                    "value": "test2",
                    "color": "#FF34FF",
                    "type": "polygon",
                    "geometry": {
                        "coordinates": [
                            [
                                [
                                    -99.20775055066333,
                                    19.37308760065266
                                ],
                                [
                                    -99.20764572089253,
                                    19.373016691720807
                                ],
                                [
                                    -99.20759511302744,
                                    19.37308946264962
                                ],
                                [
                                    -99.20766178156738,
                                    19.37316566511257
                                ],
                                [
                                    -99.20775055066333,
                                    19.37308760065266
                                ]
                            ]
                        ]
                    }
                },
                {
                    "featureId": "cknjenvly000e3g68u0b05595",
                    "schemaId": "cknjemcpt0l4n0y92d3oo7no3",
                    "title": "test3",
                    "value": "test3",
                    "color": "#FF4A46",
                    "type": "point",
                    "geometry": {
                        "coordinates": [
                            -99.20803986635566,
                            19.372954675921154
                        ]
                    }
                }
            ],
            "classifications": []
        },
        "Created By": "dallas@labelbox.com",
        "Project Name": "Geospatial export test",
        "Created At": "2021-04-15T21:39:26.000Z",
        "Updated At": "2021-04-15T21:41:16.000Z",
        "Seconds to Label": 60.72,
        "External ID": "cklidjjbk0ngb0y5p3nbw2960",
        "Agreement": -1,
        "Benchmark Agreement": -1,
        "Benchmark ID": null,
        "Dataset Name": "geospatial.json",
        "Reviews": [],
        "View Label": "https://editor.labelbox.com?project=cknje90o908gu0807i5ukcwvr&label=cknjenzdz000j3g68m4m0si3n",
        "Has Open Issues": 0
    }
]

Ontology

An Ontology is a structured and hierarchical representation of a set of Annotation schemas used within one or more projects.

Parameter

Description

tools

Category that represents the Object-type annotations (Bounding box, Segmentation mask, Polygon, Point, Polyline, Entity).

classifications

Category that represents the Classification-type annotations (Radio, Checklist, Free-form text, Dropdown).

tools.schemaNodeId / classifications.schemaNodeId

The schema node contains information such as the annotation's place in the ontology hierarchy, which ontology the annotation belongs to, and which feature schema (AKA annotation schema) it references. See Ontology management to learn more.

tools.featureSchemaId / classifications.featureSchemaId

The feature schema (AKA annotation schema) holds information like name, kind, and color. See Ontology management to learn more.

tools.required / classifications.required

Indicates whether the annotation is required in order for the labeler to submit the Label.

tools.name

Text that appears as the name of the Object-type annotation.

tools.tool

Tool used to create the Object-type annotation (rectangle, superpixel, point, line, or polygon).

tools.color

Color of the Object-type annotation.

classifications.instructions

Text that appears as the Classification question.

classifications.name

Labelbox internal name of the Classification question.

classifications.type

Classification type (radio, checklist, dropdown, or text).

classifications.options.label

Text that appears as a Classification answer option.

classifications.options.value

Labelbox internal name of the Classification answer option.

{
    "ontology": {
        "normalized": {
            "tools": [
                {
                    "schemaNodeId": "ckn94hhay0ops0y69hb9ghaxt",
                    "featureSchemaId": "ckn94hhay0opt0y6993fb64bl",
                    "required": false,
                    "name": "Sample object 1",
                    "tool": "rectangle",
                    "color": "#ffb31c",
                    "classifications": []
                },
                {
                    "schemaNodeId": "ckn94hhay0opu0y69dfgo25ab",
                    "featureSchemaId": "ckn94hhay0opv0y69fbpg76bs",
                    "required": false,
                    "name": "Sample object 2",
                    "tool": "superpixel",
                    "color": "#FF34FF",
                    "classifications": []
                }
            ],
            "classifications": [
                {
                    "schemaNodeId": "ckn94hhax0opq0y6967ygglnq",
                    "featureSchemaId": "ckn94hhax0opr0y6936u2db78",
                    "required": true,
                    "instructions": "Is it daytime?",
                    "name": "is_it_daytime?",
                    "type": "radio",
                    "options": [
                        {
                            "schemaNodeId": "ckn94hhbn0opw0y6950qq18yo",
                            "featureSchemaId": "ckn94hhbn0opx0y69bwh6b3je",
                            "label": "yes",
                            "value": "yes"
                        },
                        {
                            "schemaNodeId": "ckn94hhbo0opy0y698o9kb178",
                            "featureSchemaId": "ckn94hhbo0opz0y69d5uv16fn",
                            "label": "no",
                            "value": "no"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "ontology": {
        "normalized": {
            "tools": [
                {
                    "schemaNodeId": "ckkojo9m907330yca3ed5ge6m",
                    "featureSchemaId": "ckkojo9m907340ycaeny0dsvi",
                    "required": false,
                    "name": "Bounding box",
                    "tool": "rectangle",
                    "color": "#1CE6FF",
                    "classifications": [
                        {
                            "schemaNodeId": "cklmow53001ac0ycu0zy24atw",
                            "featureSchemaId": "cklmow53001ad0ycu2i6l75jc",
                            "required": false,
                            "instructions": "Visibility",
                            "name": "visibility",
                            "type": "radio",
                            "options": [
                                {
                                    "schemaNodeId": "cklmow54a01aj0ycudrzm7lh8",
                                    "featureSchemaId": "cklmow54a01ak0ycuhm2p474y",
                                    "label": "0",
                                    "value": "0"
                                },
                                {
                                    "schemaNodeId": "cklmow54b01al0ycu7fhn2zlo",
                                    "featureSchemaId": "cklmow54b01am0ycu3t6p311r",
                                    "label": "1",
                                    "value": "1"
                                }
                            ]
                        }
                    ]
                }
            ],
            "classifications": [
                {
                    "schemaNodeId": "ckkojo9m8072z0yca7rlth7xq",
                    "featureSchemaId": "ckkojo9m807300ycaglf19mj4",
                    "required": false,
                    "instructions": "Sample radio question",
                    "name": "sample_radio_question",
                    "type": "radio",
                    "options": [
                        {
                            "schemaNodeId": "ckkojo9o6073d0yca8nai9gz4",
                            "featureSchemaId": "ckkojo9o6073e0yca451e7ach",
                            "label": "Option 1",
                            "value": "option_1",
                            "options": [
                                {
                                    "schemaNodeId": "cklmtbyuj11q90yao3ko3h8lk",
                                    "featureSchemaId": "cklmtbyuj11qa0yao0zn2d9sg",
                                    "required": false,
                                    "instructions": "Nested radio classification",
                                    "name": "nested_radio_classification",
                                    "type": "radio",
                                    "options": [
                                        {
                                            "schemaNodeId": "cklmtbyv711qj0yao2yhlh4tg",
                                            "featureSchemaId": "cklmtbyv711qk0yaogyhsddok",
                                            "label": "Option 1a",
                                            "value": "option_1a"
                                        },
                                        {
                                            "schemaNodeId": "cklmtbyv711ql0yao3x718wp9",
                                            "featureSchemaId": "cklmtbyv711qm0yaoe0vo0kul",
                                            "label": "Option 1b",
                                            "value": "option_1b"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "schemaNodeId": "ckkojo9o6073f0ycae6kudlj9",
                            "featureSchemaId": "ckkojo9o6073g0ycafpjw964n",
                            "label": "Option 2",
                            "value": "option_2"
                        }
                    ]
                },
                {
                    "schemaNodeId": "ckkojo9m807310yca76dt4bz7",
                    "featureSchemaId": "cklmtbytx11q50yao4vzo4v4d",
                    "required": false,
                    "instructions": "Checklist question",
                    "name": "checklist_question",
                    "type": "checklist",
                    "options": [
                        {
                            "schemaNodeId": "ckkojo9o507370ycagr048zxk",
                            "featureSchemaId": "cklmtbyur11qg0yaobj0n8yky",
                            "label": "Option 1",
                            "value": "option_1"
                        },
                        {
                            "schemaNodeId": "ckkojo9o507390yca5wncesjj",
                            "featureSchemaId": "cklmtbyus11qh0yaodc8gb9s9",
                            "label": "Option 2",
                            "value": "option_2"
                        },
                        {
                            "schemaNodeId": "ckkojo9o5073b0yca2usxgag6",
                            "featureSchemaId": "cklmtbyus11qi0yao94m1cm32",
                            "label": "Option 3",
                            "value": "option_3"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "ontology": {
        "normalized": {
            "tools": [
                {
                    "schemaNodeId": "ckkd4yl0e0le20ycl6l2d6s8p",
                    "featureSchemaId": "ckkd4yl0e0le30ycl7i4944l5",
                    "required": false,
                    "name": "A",
                    "tool": "named-entity",
                    "color": "#1CE6FF",
                    "classifications": []
                }
            ],
            "classifications": [
                {
                    "schemaNodeId": "cknp3ctst06np0yct5jev4ore",
                    "featureSchemaId": "cknp3ctst06nq0ycte8icc2l3",
                    "required": false,
                    "instructions": "Radio",
                    "name": "radio",
                    "type": "radio",
                    "options": [
                        {
                            "schemaNodeId": "cknp3cttx06od0yctg909cae2",
                            "featureSchemaId": "cknp3cttx06oe0yct3f0d6pmz",
                            "label": "Yes",
                            "value": "yes"
                        },
                        {
                            "schemaNodeId": "cknp3ctty06of0yctf5qlbjqa",
                            "featureSchemaId": "cknp3ctty06og0yct8xl6ekgm",
                            "label": "No",
                            "value": "no"
                        }
                    ]
                },
                {
                    "schemaNodeId": "cknp3ctsu06nr0yct077z4b1k",
                    "featureSchemaId": "cknp3dfo51h900y9y5j10g7hg",
                    "required": false,
                    "instructions": "Checklist",
                    "name": "checklist",
                    "type": "checklist",
                    "options": [
                        {
                            "schemaNodeId": "cknp3cttq06ny0yct6ox0hy4g",
                            "featureSchemaId": "cknp3dfv21h9a0y9yagz41wtq",
                            "label": "1",
                            "value": "1"
                        },
                        {
                            "schemaNodeId": "cknp3cttr06o00yct90l6fnyq",
                            "featureSchemaId": "cknp3dfv21h9b0y9yg34i8xru",
                            "label": "2",
                            "value": "2"
                        },
                        {
                            "schemaNodeId": "cknp3cttr06o20yct49c75ezo",
                            "featureSchemaId": "cknp3dfv31h9c0y9y6rzcctxa",
                            "label": "3",
                            "value": "3"
                        }
                    ]
                },
                {
                    "schemaNodeId": "cknp3ctsu06nt0yct3x9icvyf",
                    "featureSchemaId": "cknp3ctsu06nu0yctf0v5gzij",
                    "required": false,
                    "instructions": "Free-form text",
                    "name": "free-form_text",
                    "type": "text",
                    "options": []
                }
            ],
            "projectInstructions": "https://storage.labelbox.com/ck52rvx0mpw4g0766wgqvjtl9%2Fd1bc1a95-66d6-0738-0827-6b9ca0ff6554-labelbox-python-reference.pdf?Expires=1611792936339&KeyName=labelbox-assets-key-1&Signature=OPUcrEiPLjbYIGnhRy71j-E_7Mo"
        }
    }
}