Table of Contents
Attachments
Attachments are media you can attach to a Data Row to provide labelers with contextual information about the asset to be labeled.
There are four attachment types:
IMAGE
TEXT
VIDEO
IMAGE_OVERLAY
You can add attachments via JSON. To learn how to use the createAssetMetadata
mutation to add attachments to a Data Row, see our GraphQL docs. Specifying type and value under info
is still supported. See old format here.
Type: IMAGE
To attach an IMAGE
type attachment to a Data Row, use the following format for attachments
:
[
{
"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"
}
]
}
]
Where:
type
is REQUIRED and should beIMAGE
.value
is REQUIRED and accepts anhttps://
URL to an external file.
Type: VIDEO
To attach a VIDEO
type attachment to a Data Row, use the following format for attachments
:
[
{
"data": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. At auctor urna nunc id cursus metus aliquam." ,
"attachments": [
{
"type": "VIDEO",
"value": "https://storage.googleapis.com/labelbox-sample-datasets/Videos/shibuya-1230-1530.mp4"
}
]
}
]
Where:
type
is REQUIRED and should beVIDEO
.value
is REQUIRED and accepts anhttps://
path to an external file.
Type: TEXT
To attach a TEXT
type attachment to a Data Row, use the following format for attachments
.
[
{
"externalId": "2017-Tesla-Model-S-P90D-102.jpg",
"imageUrl": "https://storage.googleapis.com/labelbox-example-datasets/tesla/2017-Tesla-Model-S-P90D-102.jpg",
"attachments": [
{
"type": "TEXT",
"value": "Some sample text"
}
]
}
]
Where:
type
is REQUIRED and should beTEXT
.value
is REQUIRED and accepts anhttps://
path to an external file OR a string of text.
Type: IMAGE_OVERLAY
You can add up to 9 IMAGE_OVERLAY
attachments to a Data Row.
Make sure the dimensions of your IMAGE_OVERLAY
attachments match the dimensions of the image to be labeled. Any IMAGE_OVERLAY
attachments that have different dimensions than the base image will be automatically scaled to match the dimensions of the base image.
The following is not supported for IMAGE_OVERLAY
attachments:
- Manipulate size, position, or name of image layers.
- Annotations on image layers (annotations are only applied to the image asset on the Data Row).
- Image overlay on video or text assets.
To attach an IMAGE_OVERLAY
type attachment to a Data Row, use the following format for attachments
:
[
{
"externalId": "basic.png",
"imageUrl": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/basic.png",
"attachments": [
{
"type": "IMAGE_OVERLAY",
"value": "https://labelbox.s3-us-west-2.amazonaws.com/coregistered-images/rgb.png"
}
]
}
]
Where:
type
is REQUIRED and should beIMAGE_OVERLAY
. Note:IMAGE_OVERLAY
types can only be attached to image assets.value
is REQUIRED and accepts anhttps://
path to an external file.
How to view attachments
To view attachments specified as IMAGE_OVERLAY
, click on the layers icon in the top right corner of the Editor. Use the hotkeys to quickly toggle between the image layers.

To view attachments specified as IMAGE
, VIDEO
, or TEXT
, click on the label icon in the top left corner of the Editor. These attachments will appear in the right panel.
