Overview
Export API helps CityLens administrators export detection results for analysis.
Main features
With the Export API, you can get:
- A list of original frames and their metadata with filtering by capture date and time.
- Original frames in JPEG format.
- Frames with highlighted detected objects.
- A list of available detectors: categories of urban environment objects that can be detected in frames.
- A list of objects detected in frames with filtering by capture date, time, and detector type.
For more information, see the examples and the API Reference.
Getting started
1. Get an access key
To get an access key and URL for accessing the service API, contact your organization administrator.
The number of keys issued for one organization is not limited.
2. Send a request
To get a list of objects detected in frames, send a GET request to /export-api/v1/detections/objects, specifying the API key value in the X-API-Key request header and passing the required parameters in the query string.
Request example
curl --request GET \
--url 'API_URL/export-api/v1/detections/objects?from_dt=2025-09-01T00:00:00&to_dt=2025-12-30T00:00:00&detector_name=signs&locale=en_AE&limit=100' \
--header 'X-API-Key: API_KEY'
Where:
API_URL— URL for accessing the API, which you received from your organization administrator.from_dt(required parameter) - start date and time when the frame was captured inYYYY-MM-DDTHH:MM:SSformat.to_dt(required parameter) - end date and time when the frame was captured inYYYY-MM-DDTHH:MM:SSformat.detector_name- name of the detector (category of detectable objects) used for filtering. For example,signs- road signs.locale- language of detected object names in the response.limit- maximum number of objects returned in the response.API_KEY- access key that you received from your organization administrator.
Response example
response.json
{
"detected_objects": [
{
"id": 409251,
"lon": 44.69109857763772,
"lat": 39.82937064594726,
"type": "signs",
"label": "4_2_1",
"name": "Detour on the right Sign",
"value": null,
"is_tmp": false,
"first_seen_datetime": "2025-09-11T11:03:54.984000",
"last_seen_datetime": "2025-09-11T11:03:54.984000",
"bbox": {
"x_from": 1670,
"y_from": 369,
"width": 87,
"height": 86
},
"frame_id": 10256311,
"frame_url": "/export-api/v1/frames/10256311/image",
"frame_url_with_detections": "/export-api/v1/frames/10256311/predictions-image"
},
{
"id": 422030,
"lon": 45.31161451674012,
"lat": 39.749436663989144,
"type": "signs",
"label": "3_24",
"name": "Maximum speed limit Sign",
"value": 50.0,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:30.764000",
"last_seen_datetime": "2025-11-02T14:07:31.289000",
"bbox": {
"x_from": 1464,
"y_from": 489,
"width": 138,
"height": 139
},
"frame_id": 10779055,
"frame_url": "/export-api/v1/frames/10779055/image",
"frame_url_with_detections": "/export-api/v1/frames/10779055/predictions-image"
},
{
"id": 422031,
"lon": 45.311685502259714,
"lat": 39.748618444895996,
"type": "signs",
"label": "2_5",
"name": "Stop Sign",
"value": null,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:39.755000",
"last_seen_datetime": "2025-11-02T14:07:39.755000",
"bbox": {
"x_from": 1672,
"y_from": 330,
"width": 117,
"height": 105
},
"frame_id": 10779087,
"frame_url": "/export-api/v1/frames/10779087/image",
"frame_url_with_detections": "/export-api/v1/frames/10779087/predictions-image"
},
{
"id": 422032,
"lon": 45.31152877168696,
"lat": 39.75036066557599,
"type": "signs",
"label": "3_24",
"name": "Maximum speed limit Sign",
"value": 10.0,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:24.564000",
"last_seen_datetime": "2025-11-02T14:07:24.564000",
"bbox": {
"x_from": 1511,
"y_from": 330,
"width": 143,
"height": 133
},
"frame_id": 10779017,
"frame_url": "/export-api/v1/frames/10779017/image",
"frame_url_with_detections": "/export-api/v1/frames/10779017/predictions-image"
},
{
"id": 422033,
"lon": 45.31156437203809,
"lat": 39.750479372403134,
"type": "signs",
"label": "3_24",
"name": "Maximum speed limit Sign",
"value": 70.0,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:24.313000",
"last_seen_datetime": "2025-11-02T14:07:24.313000",
"bbox": {
"x_from": 1333,
"y_from": 431,
"width": 83,
"height": 83
},
"frame_id": 10779015,
"frame_url": "/export-api/v1/frames/10779015/image",
"frame_url_with_detections": "/export-api/v1/frames/10779015/predictions-image"
},
{
"id": 422034,
"lon": 45.31161752061028,
"lat": 39.749444042695735,
"type": "signs",
"label": "2_2",
"name": "End of the priority road Sign",
"value": null,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:30.764000",
"last_seen_datetime": "2025-11-02T14:07:31.289000",
"bbox": {
"x_from": 1434,
"y_from": 210,
"width": 153,
"height": 153
},
"frame_id": 10779055,
"frame_url": "/export-api/v1/frames/10779055/image",
"frame_url_with_detections": "/export-api/v1/frames/10779055/predictions-image"
},
{
"id": 422035,
"lon": 45.31161603480356,
"lat": 39.74944031054389,
"type": "signs",
"label": "2_4",
"name": "Give way Sign",
"value": null,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:30.764000",
"last_seen_datetime": "2025-11-02T14:07:31.289000",
"bbox": {
"x_from": 1441,
"y_from": 360,
"width": 164,
"height": 128
},
"frame_id": 10779055,
"frame_url": "/export-api/v1/frames/10779055/image",
"frame_url_with_detections": "/export-api/v1/frames/10779055/predictions-image"
},
{
"id": 422036,
"lon": 45.311692231774046,
"lat": 39.748703229422745,
"type": "signs",
"label": "2_4",
"name": "Give way Sign",
"value": null,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:38.717000",
"last_seen_datetime": "2025-11-02T14:07:38.717000",
"bbox": {
"x_from": 1642,
"y_from": 341,
"width": 134,
"height": 108
},
"frame_id": 10779083,
"frame_url": "/export-api/v1/frames/10779083/image",
"frame_url_with_detections": "/export-api/v1/frames/10779083/predictions-image"
},
{
"id": 422037,
"lon": 45.311834689373455,
"lat": 39.7484869208197,
"type": "signs",
"label": "5_15_5",
"name": "End of the lane Sign",
"value": null,
"is_tmp": false,
"first_seen_datetime": "2025-11-02T14:07:41.779000",
"last_seen_datetime": "2025-11-02T14:07:43.783000",
"bbox": {
"x_from": 127,
"y_from": 528,
"width": 70,
"height": 79
},
"frame_id": 10779093,
"frame_url": "/export-api/v1/frames/10779093/image",
"frame_url_with_detections": "/export-api/v1/frames/10779093/predictions-image"
}
],
"total_count": 9,
"limit": 100,
"offset": 0,
"processed": false
}