🧩
Objects
Learn the structure of content entries in the API.

1. Complete Data Set

This is the structure of the complete data set holding your API key and a database of all content entries associated with your API key.
This data set is retrieved by making the /query API call.
Object
Example
1
{
2
"apiKey": "API_KEY", // Your API Key
3
"db": { // A collection of all content entries
4
...
5
}
6
}
Copied!
1
{
2
"apiKey": "API_KEY",
3
"db": {
4
"edc343c7-37d3-4132-9cd7-52c4902b24c7": {
5
"id": "edc343c7-37d3-4132-9cd7-52c4902b24c7",
6
"target": {
7
"id": "0c63d1f8-8038-478b-8b60-df6cedeff5cb",
8
"type": "BRICK_TARGET",
9
"holograms": [
10
"0839a395-4a48-47d1-b819-a923184a7314"
11
]
12
},
13
"hologram": {
14
"filename": "Skyscraper.obj",
15
"storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
16
"textureFilenames": [
17
"Skyscraper_BaseColor.png"
18
],
19
"textureStorageIDs": [
20
"f9b43711-cf79-44e5-90c5-ac781c8d9288"
21
],
22
"materialFilename": "Skyscraper.mtl",
23
"materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
24
"id": "0839a395-4a48-47d1-b819-a923184a7314",
25
"type": "MODEL_HOLOGRAM",
26
"targetID": "0c63d1f8-8038-478b-8b60-df6cedeff5cb"
27
},
28
"sdks": [
29
true,
30
true,
31
false,
32
true,
33
false,
34
false,
35
false,
36
true,
37
true
38
],
39
"additionalData": {
40
"qrWebXRStorageID": "5ead9dc6-0b11-4133-b342-d43ac95d1116",
41
"qrARjsStorageFilename": "qr_arjs_blue-water-4646.png",
42
"qrARjsTargetStorageFilename": "qr_arjs_blue-water-4646.patt",
43
"vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
44
"glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
45
"qrARjsMarkerStorageFilename": "marker_qr_arjs_blue-water-4646.png",
46
"source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
47
"qrARjsTargetStorageID": "e85b7db2-42a9-4f76-aacc-8f7be4a5e05f",
48
"usdzHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.usdz",
49
"qrARjsStorageID": "f78b7b84-979d-4dfc-b478-e369b560a623",
50
"accessHistory": "[\"1587253959697\",\"1587254928553\",\"1587254944219\",\"1587254945465\"]",
51
"createdAt": "1587253959697",
52
"qrWebXRStorageFilename": "qr_webxr_blue-water-4646.png",
53
"usdzHologramStorageFilename": "Skyscraper.usdz",
54
"vuforiaHologramStorageFilename": "Skyscraper.h",
55
"lastAccessed": "1587254945465",
56
"qrARjsMarkerStorageID": "343df194-e7ae-4c34-adbf-5718542aca37",
57
"glbHologramStorageFilename": "Skyscraper.glb"
58
}
59
}
60
}
61
}
Copied!

2. Entries Database

This is the structure of the collection of all content entries associated with your API key.
This database is retrieved by making the /query API call and referring to its db component.
Object
Example
1
"db": { // A collection of all content entries
2
"ENTRY_ID_1": { // First content entry
3
...
4
}
5
"ENTRY_ID_2": { // Second content entry
6
...
7
}
8
... // Additonal content entries
9
}
Copied!
1
"db": {
2
"edc343c7-37d3-4132-9cd7-52c4902b24c7": {
3
"id": "edc343c7-37d3-4132-9cd7-52c4902b24c7",
4
"target": {
5
"id": "0c63d1f8-8038-478b-8b60-df6cedeff5cb",
6
"type": "BRICK_TARGET",
7
"holograms": [
8
"0839a395-4a48-47d1-b819-a923184a7314"
9
]
10
},
11
"hologram": {
12
"filename": "Skyscraper.obj",
13
"storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
14
"textureFilenames": [
15
"Skyscraper_BaseColor.png"
16
],
17
"textureStorageIDs": [
18
"f9b43711-cf79-44e5-90c5-ac781c8d9288"
19
],
20
"materialFilename": "Skyscraper.mtl",
21
"materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
22
"id": "0839a395-4a48-47d1-b819-a923184a7314",
23
"type": "MODEL_HOLOGRAM",
24
"targetID": "0c63d1f8-8038-478b-8b60-df6cedeff5cb"
25
},
26
"sdks": [
27
true,
28
true,
29
false,
30
true,
31
false,
32
false,
33
false,
34
true,
35
true
36
],
37
"additionalData": {
38
"qrWebXRStorageID": "5ead9dc6-0b11-4133-b342-d43ac95d1116",
39
"qrARjsStorageFilename": "qr_arjs_blue-water-4646.png",
40
"qrARjsTargetStorageFilename": "qr_arjs_blue-water-4646.patt",
41
"vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
42
"glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
43
"qrARjsMarkerStorageFilename": "marker_qr_arjs_blue-water-4646.png",
44
"source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
45
"qrARjsTargetStorageID": "e85b7db2-42a9-4f76-aacc-8f7be4a5e05f",
46
"usdzHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.usdz",
47
"qrARjsStorageID": "f78b7b84-979d-4dfc-b478-e369b560a623",
48
"accessHistory": "[\"1587253959697\",\"1587254928553\",\"1587254944219\",\"1587254945465\",\"1587254963484\"]",
49
"createdAt": "1587253959697",
50
"qrWebXRStorageFilename": "qr_webxr_blue-water-4646.png",
51
"usdzHologramStorageFilename": "Skyscraper.usdz",
52
"vuforiaHologramStorageFilename": "Skyscraper.h",
53
"lastAccessed": "1587254963484",
54
"qrARjsMarkerStorageID": "343df194-e7ae-4c34-adbf-5718542aca37",
55
"glbHologramStorageFilename": "Skyscraper.glb"
56
}
57
}
58
}
Copied!

3. Content Entries

This is the structure of a single content entry in the database associated with your API key.
This content entry is retrieved by making the /query API call and referring to thedb['ENTRY_ID'] component.
Object
Example
1
"ENTRY_ID": { // First content entry
2
"id": "ENTRY_ID", // Content entry ID
3
"hologram": { // The hologram
4
...
5
},
6
"target": { // The target
7
...
8
},
9
"additionalData": { // The metadata sscocaite with this entry
10
...
11
},
12
"sdks": [ // A list of SDK supporting this content
13
...
14
]
15
}
Copied!
1
"edc343c7-37d3-4132-9cd7-52c4902b24c7": {
2
"id": "edc343c7-37d3-4132-9cd7-52c4902b24c7",
3
"target": {
4
"id": "0c63d1f8-8038-478b-8b60-df6cedeff5cb",
5
"type": "BRICK_TARGET",
6
"holograms": [
7
"0839a395-4a48-47d1-b819-a923184a7314"
8
]
9
},
10
"hologram": {
11
"filename": "Skyscraper.obj",
12
"storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
13
"textureFilenames": [
14
"Skyscraper_BaseColor.png"
15
],
16
"textureStorageIDs": [
17
"f9b43711-cf79-44e5-90c5-ac781c8d9288"
18
],
19
"materialFilename": "Skyscraper.mtl",
20
"materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
21
"id": "0839a395-4a48-47d1-b819-a923184a7314",
22
"type": "MODEL_HOLOGRAM",
23
"targetID": "0c63d1f8-8038-478b-8b60-df6cedeff5cb"
24
},
25
"additionalData": {
26
"qrWebXRStorageID": "5ead9dc6-0b11-4133-b342-d43ac95d1116",
27
"qrARjsStorageFilename": "qr_arjs_blue-water-4646.png",
28
"qrARjsTargetStorageFilename": "qr_arjs_blue-water-4646.patt",
29
"vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
30
"glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
31
"qrARjsMarkerStorageFilename": "marker_qr_arjs_blue-water-4646.png",
32
"source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
33
"qrARjsTargetStorageID": "e85b7db2-42a9-4f76-aacc-8f7be4a5e05f",
34
"usdzHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.usdz",
35
"qrARjsStorageID": "f78b7b84-979d-4dfc-b478-e369b560a623",
36
"accessHistory": "[\"1587253959697\",\"1587254928553\",\"1587254944219\",\"1587254945465\",\"1587254963484\",\"1587255480604\",\"1587255693450\"]",
37
"createdAt": "1587253959697",
38
"qrWebXRStorageFilename": "qr_webxr_blue-water-4646.png",
39
"usdzHologramStorageFilename": "Skyscraper.usdz",
40
"vuforiaHologramStorageFilename": "Skyscraper.h",
41
"lastAccessed": "1587255693450",
42
"qrARjsMarkerStorageID": "343df194-e7ae-4c34-adbf-5718542aca37",
43
"glbHologramStorageFilename": "Skyscraper.glb"
44
},
45
"sdks": [
46
true,
47
true,
48
false,
49
true,
50
false,
51
false,
52
false,
53
true,
54
true
55
]
56
}
Copied!

4. Holograms

This is the structure of a single hologram inside a single content entry in the database based on type.
This hologram is retrieved by making the /query API call and referring to thedb['ENTRY_ID']['hologram'] component.

Any Type of Hologram

This is data available for any hologram of any type.
Object
Example
1
"hologram": {
2
"id": "HOLOGRAM_ID", // Hologram ID
3
"type": "HOLOGRAM_TYPE", // Hologram type, e.g. MODEL_HOLOGRAM, VIDEO_HOLOGRAM, or IMAGE_HOLOGRAM
4
"targetID": "TARGET_ID", // The ID of the associated target
5
"filename": "FILENAME", // The filename of the hologram
6
"storageID": "STORAGE_ID" // The storage ID of the hologram file
7
},
Copied!
1
"hologram": {
2
"id": "9d45a992-4f27-4559-9eef-6cec05f79ce7",
3
"type": "VIDEO_HOLOGRAM",
4
"targetID": "7daa5469-2ac7-40f6-8823-814ac2e596f8",
5
"filename": "big_buck_bunny.mp4",
6
"storageID": "fa67df18-2a60-4bb6-a7b6-3d5d6a80c6d8"
7
},
Copied!

Model Holograms

This is data available for model holograms.
Object
Example
1
"hologram": {
2
"id": "HOLOGRAM_ID", // Hologram ID
3
"type": "MODEL_HOLOGRAM", // Hologram type
4
"targetID": "TARGET_ID", // The ID of the associated target
5
"filename": "FILENAME", // The filename of the hologram
6
"storageID": "STORAGE_ID", // The storage ID of the hologram file
7
"textureFilenames": [ // A collection of the filenames of the hologram's texture files
8
"TEXTURE_FILENAME_1", // The filename of the first texture file
9
"TEXTURE_FILENAME_2", // The filename of the second texture file
10
... // Additional texture files
11
],
12
"textureStorageIDs": [ // A collection of the storage IDs of the hologram's texture files
13
"TEXTURE_STORAGE_ID_1", // The storage ID of the first texture file
14
"TEXTURE_STORAGE_ID_2", // The storage ID of the second texture file
15
... // Additional texture files
16
],
17
"materialFilename": "MATERIAL_FILENAME", // The filename of the hologram's material file
18
"materialStorageID": "MATERIAL STORAGE_ID" // The storage ID of the hologram's material file
19
},
Copied!
1
"hologram": {
2
"id": "0839a395-4a48-47d1-b819-a923184a7314",
3
"type": "MODEL_HOLOGRAM",
4
"targetID": "0c63d1f8-8038-478b-8b60-df6cedeff5cb",
5
"filename": "Skyscraper.obj",
6
"storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
7
"textureFilenames": [
8
"Skyscraper_BaseColor.png"
9
],
10
"textureStorageIDs": [
11
"f9b43711-cf79-44e5-90c5-ac781c8d9288"
12
],
13
"materialFilename": "Skyscraper.mtl",
14
"materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d"
15
},
Copied!

Video Holograms

This is data available for video holograms.
Object
Example
1
"hologram": {
2
"id": "HOLOGRAM_ID", // Hologram ID
3
"type": "VIDEO_HOLOGRAM", // Hologram type
4
"targetID": "TARGET_ID", // The ID of the associated target
5
"filename": "FILENAME", // The filename of the hologram
6
"storageID": "STORAGE_ID" // The storage ID of the hologram file
7
},
Copied!
1
"hologram": {
2
"id": "9d45a992-4f27-4559-9eef-6cec05f79ce7",
3
"type": "VIDEO_HOLOGRAM",
4
"targetID": "7daa5469-2ac7-40f6-8823-814ac2e596f8",
5
"filename": "big_buck_bunny.mp4",
6
"storageID": "fa67df18-2a60-4bb6-a7b6-3d5d6a80c6d8"
7
},
Copied!

Image Holograms

This is data available for image holograms.
Object
Example
1
"hologram": {
2
"id": "HOLOGRAM_ID", // Hologram ID
3
"type": "VIDEO_HOLOGRAM", // Hologram type; same as for video holograms
4
"targetID": "TARGET_ID", // The ID of the associated target
5
"filename": "FILENAME", // The filename of the hologram
6
"storageID": "STORAGE_ID" // The storage ID of the hologram file
7
},
Copied!
1
"hologram": {
2
"id": "9d45a992-4f27-4559-9eef-6cec05f79ce7",
3
"type": "VIDEO_HOLOGRAM",
4
"targetID": "7daa5469-2ac7-40f6-8823-814ac2e596f8",
5
"filename": "air.png",
6
"storageID": "fa67df18-2a60-4bb6-a7b6-3d5d6a80c6d8"
7
},
Copied!

5. Targets

This is the structure of a single target inside a single content entry in the database based on type.
This target is retrieved by making the /query API call and referring to thedb['ENTRY_ID']['target'] component.

Any Type of Target

This is data available for any target of any type.
Object
Example
1
"target": {
2
"id": "TARGET_ID", // Target ID
3
"type": "TARGET_TYPE", // Target type, e.g. BRICK_TARGET, GEOLOCATION_TARGET, or IMAGE_TARGET
4
"holograms": [ // A collection of IDs of holograms associated with this target
5
"HOLOGRAM_ID_1", // The ID of the first holograms
6
"HOLOGRAM_ID_2", // The ID of the second holograms
7
... // Additional holograms
8
]
9
},
Copied!
1
"target": {
2
"id": "0c63d1f8-8038-478b-8b60-df6cedeff5cb",
3
"type": "BRICK_TARGET",
4
"holograms": [
5
"0839a395-4a48-47d1-b819-a923184a7314"
6
]
7
},
Copied!

Surface Targets

This is the data available for surface targets.
Object
Example
1
"target": {
2
"id": "TARGET_ID", // Target ID
3
"type": "BRICK_TARGET", // Target type
4
"holograms": [ // A collection of IDs of holograms associated with this target
5
"HOLOGRAM_ID_1", // The ID of the first holograms
6
"HOLOGRAM_ID_2", // The ID of the second holograms
7
... // Additional holograms
8
]
9
},
Copied!
1
"target": {
2
"id": "0c63d1f8-8038-478b-8b60-df6cedeff5cb",
3
"type": "BRICK_TARGET",
4
"holograms": [
5
"0839a395-4a48-47d1-b819-a923184a7314"
6
]
7
},
Copied!

Location Targets

Object
Example
1
"target": {
2
"id": "TARGET_ID", // Target ID
3
"type": "GEOLOCATION_TARGET",// Target type
4
"holograms": [ // A collection of IDs of holograms associated with this target
5
"HOLOGRAM_ID_1", // The ID of the first holograms
6
"HOLOGRAM_ID_2", // The ID of the second holograms
7
... // Additional holograms
8
],
9
"country": "COUNTRY", // The location's country, e.g. US
10
"city": "CITY", // The location's country, e.g. New York
11
"place": "NAME", // The location's name, e.g Times Square
12
"latitude": ##.######, // The location's latitude coordinate
13
"longitude": ##.###### // The location's longitude coordinate
14
},
Copied!
1
"target": {
2
"id": "803d5d89-1615-455d-ad49-15c69bfc3f4f",
3
"type": "GEOLOCATION_TARGET",
4
"holograms": [
5
"303ee6b8-f63a-4827-99d5-073dad8569f6"
6
],
7
"country": "US",
8
"city": "New York",
9
"place": "Times Square",
10
"latitude": 40.713055,
11
"longitude": -74.007225
12
},
13
​
Copied!

Image Targets

Object
Example
1
"target": {
2
"id": "TARGET_ID", // Target ID
3
"type": "BRICK_TARGET", // Target type
4
"holograms": [ // A collection of IDs of holograms associated with this target
5
"HOLOGRAM_ID_1", // The ID of the first holograms
6
"HOLOGRAM_ID_2", // The ID of the second holograms
7
... // Additional holograms
8
]
9
"filename": "FILENAME", // The filename of the image file
10
"storageID": "STORAGE_ID" // The storage ID of the image file
11
},
Copied!
1
"target": {
2
"id": "935a9bb9-3cbd-4c42-a899-68dc41567e7a",
3
"type": "IMAGE_TARGET",
4
"holograms": [
5
"b963bce7-41be-4d15-9713-2d63f1917132"
6
],
7
"filename": "air.png",
8
"storageID": "f41ab59d-f4df-422c-830a-63fe4e7107f0",
9
},
Copied!

6. Metadata

This is the structure of the metadata of a single content entry in the database.
This metadata is retrieved by making the /get API call.
Alternatively, this metadata is retrieved by making the /query API call and referring to thedb['ENTRY_ID']['additionalData'] component.
A specific value can be retrieved by referring to thedb['ENTRY_ID']['additionalData'][KEY] or db['ENTRY_ID']['additionalData'].KEY.
Object
Example
1
"additionalData": {
2
"KEY_1": "VALUE_1", // The first metadata entry, i.e. pair of key and value
3
"KEY_2": "VALUE_2", // The second metadata entry, i.e. another pair of key and value
4
... // Additional metadata entries , i.e. more pairs of keys and values
5
},
Copied!
1
"additionalData": {
2
"qrWebXRStorageID": "5ead9dc6-0b11-4133-b342-d43ac95d1116",
3
"qrARjsStorageFilename": "qr_arjs_blue-water-4646.png",
4
"qrARjsTargetStorageFilename": "qr_arjs_blue-water-4646.patt",
5
"vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
6
"glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
7
"qrARjsMarkerStorageFilename": "marker_qr_arjs_blue-water-4646.png",
8
"source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
9
"qrARjsTargetStorageID": "e85b7db2-42a9-4f76-aacc-8f7be4a5e05f",
10
"usdzHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.usdz",
11
"qrARjsStorageID": "f78b7b84-979d-4dfc-b478-e369b560a623",
12
"accessHistory": "[\"1587253959697\",\"1587254928553\",\"1587254944219\",\"1587254945465\",\"1587254963484\",\"1587255480604\",\"1587255693450\"]",
13
"createdAt": "1587253959697",
14
"qrWebXRStorageFilename": "qr_webxr_blue-water-4646.png",
15
"usdzHologramStorageFilename": "Skyscraper.usdz",
16
"vuforiaHologramStorageFilename": "Skyscraper.h",
17
"lastAccessed": "1587255693450",
18
"qrARjsMarkerStorageID": "343df194-e7ae-4c34-adbf-5718542aca37",
19
"glbHologramStorageFilename": "Skyscraper.glb"
20
},
Copied!

7. Supported SDKs

This is the structure of the supported SDK array of a single content entry in the database.
Object
Example
1
"sdks": [
2
true/false, // Vuforia support
3
true/false, // ARCore support
4
true/false, // ARKit support
5
true/false, // Unity support
6
true/false, // EasyAR support
7
true/false, // Wikitude support
8
true/false, // Kudan support
9
true/false, // WebXR support
10
true/false // AR.JS support
11
],
Copied!
1
"sdks": [
2
true,
3
true,
4
false,
5
true,
6
false,
7
false,
8
false,
9
true,
10
true
11
],
Copied!
Last modified 1yr ago