Обзор
Export API помогает администраторам 2ГИС Ситискан экспортировать результаты распознавания для анализа.
Основные возможности
С помощью Export API вы можете получить:
- Список исходных кадров и их метаданных с фильтрацией по дате и времени записи.
- Исходные кадры в формате JPEG.
- Кадры с отмеченными распознанными объектами.
- Список доступных детекторов: категорий объектов городской среды, которые могут быть распознаны на кадрах.
- Список объектов, распознанных на кадрах, с фильтрацией по дате и времени записи и типу детектора.
Подробнее см. в примерах и в Справочнике API.
Начало работы
1. Получите ключ доступа
Чтобы получить ключ доступа и URL для обращения к API сервиса, обратитесь к администратору вашей организации.
Количество выпущенных ключей для одной организации не ограничено.
2. Отправьте запрос
Чтобы получить список объектов, распознанных на кадрах, отправьте GET-запрос на /export-api/v1/detections/objects, указав значение API-ключа в заголовке запроса X-API-Key и необходимые параметры в строке запроса.
Пример запроса:
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=ru_RU&limit=100' \
--header 'X-API-Key: API_KEY'
Где:
API_URL— URL для обращения к API, который вы получили от администратора вашей организации.from_dt(обязательный параметр) — начальная дата и время записи кадра в форматеYYYY-MM-DDTHH:MM:SS.to_dt(обязательный параметр) — конечная дата и время записи кадра в форматеYYYY-MM-DDTHH:MM:SS.detector_name— название детектора (категории распознаваемых объектов) для фильтрации. Например,signs— дорожные знаки.locale— язык названий распознанных объектов в ответе.limit— максимальное количество объектов в ответе.API_KEY— ключ доступа, который вы получили от администратора вашей организации.
Пример ответа:
response.json
{
"detected_objects": [
{
"id": 409251,
"lon": 44.69109857763772,
"lat": 39.82937064594726,
"type": "signs",
"label": "4_2_1",
"name": "Знак 4.2.1",
"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": "Знак 3.24",
"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": "Знак 2.5",
"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": "Знак 3.24",
"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": "Знак 3.24",
"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": "Знак 2.2",
"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": "Знак 2.4",
"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": "Знак 2.4",
"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": "Знак 5.15.5",
"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
}