API Mapflow

Примечание

Read documentation and see examples also in this Postman collection for API.

См.также

Загрузите и установите интерфейс командной строки Mapflow Python для запроса API и запуска сценариев Mapflow CLI Tool.

Авторизация в Mapflow API

Для доступа из внешних приложений, таких как плагин для QGIS, вам необходимо получить API token. Пользователи могут зарегистрироваться и получить токен по адресу https://app.mapflow.ai/account/api. Токен должен быть передан в Basic Auth параметрах, как в примере:

curl --location --request GET 'https://api.mapflow.ai/rest/projects/default' \
--header 'Authorization: Basic <YOUR TOKEN>'

Примечание

Ваш токен генерируется по запросу и состоит из <Email: API Token>

Вы можете декодировать его с помощью декодера base64 для использования в форме Basic Auth

Убедитесь, что вы сохранили токен, в противном случае вам нужно будет его переиздать.

Получение API токена

Откройте веб-приложение Mapflow. Зарегистрируйте новый аккаунт или войдите, используя Google аккаунт.
Перейдите в настройки профиля пользователя чтобы сгенерировать новый API токен.

Mapflow Processing API

API обработки Mapflow позволяет выполнять геопространственный анализ на основе искусственного интеллекта на основе спутниковых и аэрофотоснимков. Используйте его для обнаружения зданий, дорог, лесов и т. д. в большом масштабе.

Внимание

Проекты и обработки, созданные через API, синхронизируются с Mapflow.ai. Вызовы API потребляют ваши кредиты Mapflow.

Базовый URL

https://api.mapflow.ai/rest

Аутентификация

Для всех запросов API требуется токен API. Создайте свой в настройках профиля.

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.mapflow.ai/rest/user/status

Подробности см. в руководстве по авторизации.

Быстрый старт

Запустите первую обработку в 3 этапа:

Create a project

curl -X POST https://api.mapflow.ai/rest/projects \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Project",
    "description": "Buildings detection"
  }'

Ответ: {"id": "project-uuid", ...}

Create and run processing

curl -X POST https://api.mapflow.ai/rest/processings/v2 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Downtown Buildings",
    "projectId": "project-uuid",
    "wdName": "🏠 Buildings",
    "geometry": {
      "type": "Polygon",
      "coordinates": [[
        [37.6156, 55.7558],
        [37.6256, 55.7558],
        [37.6256, 55.7608],
        [37.6156, 55.7608],
        [37.6156, 55.7558]
      ]]
    },
    "params": {
      "sourceParams": {
        "dataProvider": {
          "providerName": "Mapbox",
          "zoom": 18
        }
      }
    }
  }'

Ответ: {"id": "processing-uuid", "status": "IN_PROGRESS", ...}

Проверьте статус и результаты загрузки

# Check status
curl https://api.mapflow.ai/rest/processings/{processing-uuid}/v2 \
  -H "Authorization: Bearer YOUR_TOKEN"

# Download results (when status = "OK")
curl https://api.mapflow.ai/rest/processings/{processing-uuid}/result \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o results.geojson

Следующие шаги: Изучите доступные модели, загрузите пользовательские изображения или просмотрите полный справочник по API.

API данных Mapflow

API данных Mapflow позволяет вам управлять пользовательскими изображениями, организовывать их в мозаику и выполнять поиск спутниковых изображений от внешних поставщиков. Используйте свои изображения для анализа с помощью искусственного интеллекта с помощью Processing API.

Примечание

Try our Postman Collection for interactive API testing.

Базовый URL

https://api.mapflow.ai/rest

Аутентификация

Для всех запросов API требуется токен API. Создайте свой в настройках профиля.

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.mapflow.ai/rest/rasters/memory

Подробности см. в руководстве по авторизации.

Быстрый старт

Загрузите и обработайте изображения в 3 этапа:

Create a mosaic

curl -X POST https://api.mapflow.ai/rest/rasters/mosaic \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Aerial Survey", "tags": ["survey-2024"]}'

Ответ: {"id": "mosaic-uuid", ...}

Upload images to mosaic

curl -X POST https://api.mapflow.ai/rest/rasters/mosaic/{mosaic-uuid}/image \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/orthophoto.tif"

Ответ: {"id": "image-uuid", ...}

Run processing with uploaded imagery

curl -X POST https://api.mapflow.ai/rest/processings/v2 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Building Detection",
    "projectId": "project-uuid",
    "wdName": "🏠 Buildings",
    "geometry": {...},
    "params": {
      "sourceParams": {
        "myImagery": {"mosaicId": "mosaic-uuid"}
      }
    }
  }'

Следующие шаги: Изучите поиск спутниковых изображений, управляйте пределами хранилища или просмотрите полный справочник по API.

Полную справочную документацию по API, включая все конечные точки, параметры и примеры, см. в разделе Справочник по API.

Справочник по API

Проекты

Создать проект

POST /проекты

Создает новый контейнер проекта для организации обработок.

Parameter	Тип	Необходимый	Описание
`имя`	нить	Да	Project name
`description`	нить	Нет	Project description

Example Request

{
  "name": "Urban Analysis 2026",
  "description": "Building footprints for city planning"
}

Пример ответа

{
  "id": "546d148f-19a1-40d8-8f16-d1e6dabfd204",
  "name": "Urban Analysis 2026",
  "description": "Building footprints for city planning"
}

Update project

PUT /projects/{projectId}

Обновляет имя и/или описание проекта.

Parameter	Тип	Необходимый	Описание
`projectId`	нить	Да	UUID проекта (параметр пути)
`имя`	нить	Нет	New project name
`description`	нить	Нет	Описание нового проекта

Example Request

{
  "name": "Urban Analysis 2026 - Updated",
  "description": "Building and road detection"
}

Обработка

Примечание

Рекомендуется API v2. Он использует структурированные sourceParams и inferenceParams. Версия 1 использует плоскую карту параметров и поддерживается для обратной совместимости.

Create processing (v2)

POST /processings/v2

Creates and runs an imagery analysis processing.

Parameter	Тип	Необходимый	Описание
`имя`	нить	Да	Processing name
`projectId`	нить	Да	Project UUID
`wdId` или `wdName`	нить	Да	Идентификатор или имя определения рабочего процесса (например, «🏠 Здания»).
`геометрия`	GeoJSON	Да	Область интереса (Многоугольник или МультиПолигон)
`params.sourceParams`	object	Да	Конфигурация источника изображений (см. Источники данных)
`params.inferenceParams`	object	Нет	Параметры, специфичные для модели
`блоки`	множество	Нет	Включить/отключить этапы рабочего процесса (см. Блоки рабочего процесса)
`description`	нить	Нет	Processing description
`мета`	object	Нет	Пользовательские метаданные

Пример запроса: использование Mapbox

{
  "name": "Downtown Buildings",
  "projectId": "546d148f-19a1-40d8-8f16-d1e6dabfd204",
  "wdName": "🏠 Buildings",
  "geometry": {
    "type": "Polygon",
    "coordinates": [[[37.615, 55.755], [37.625, 55.755],
                     [37.625, 55.760], [37.615, 55.760],
                     [37.615, 55.755]]]
  },
  "params": {
    "sourceParams": {
      "dataProvider": {
        "providerName": "Mapbox",
        "zoom": 18
      }
    }
  }
}

Пример запроса: использование собственных изображений

{
  "name": "Aerial Survey 2026",
  "projectId": "546d148f-19a1-40d8-8f16-d1e6dabfd204",
  "wdName": "🏠 Buildings",
  "geometry": {"type": "Polygon", "coordinates": [...]},
  "params": {
    "sourceParams": {
      "myImagery": {
        "imageIds": ["0c26a0d3-96d8-4ed5-aa62-3843d1d7905c"]
      }
    }
  }
}

Пример ответа

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Downtown Buildings",
  "status": "IN_PROGRESS",
  "percentCompleted": 0,
  "cost": 150,
  "created": "2026-02-10T10:30:00Z"
}

Get processing (v2)

GET /processings/{processingId}/v2

Получает статус обработки и подробную информацию.

Parameter	Тип	Необходимый	Описание
`processingId`	нить	Да	Обработка UUID (параметр пути)

Пример ответа

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Downtown Buildings",
  "status": "OK",
  "percentCompleted": 100,
  "area": 1200000,
  "cost": 150,
  "vectorLayer": {
    "id": "layer-uuid",
    "tileUrl": "https://app.mapflow.ai/api/layers/{z}/{x}/{y}.pbf"
  },
  "created": "2026-02-10T10:30:00Z",
  "updated": "2026-02-10T10:45:00Z"
}

Значения статуса: UNPROCESSED, IN_PROGRESS, ОЖИДАНИЕ, ОК, FAILED, ОТМЕНЕН

List processings (v2)

GET /processings/v2

Lists all user processings.

Пример ответа

[
  {
    "id": "uuid-1",
    "name": "Processing 1",
    "projectId": "project-uuid",
    "status": "OK",
    "percentCompleted": 100
  },
  {
    "id": "uuid-2",
    "name": "Processing 2",
    "status": "IN_PROGRESS",
    "percentCompleted": 45
  }
]

List processings by project (v2)

GET /projects/{projectId}/processings/v2

Lists processings for a specific project.

Calculate cost (v2)

POST /processing/cost/v2

Оценивает стоимость обработки перед запуском.

Parameter	Тип	Необходимый	Описание
`wdId`	нить	Да	Идентификатор определения рабочего процесса
`геометрия`	GeoJSON	Нет*	Area of interest
`площадькв.км`	число	Нет*	Площадь в км² (альтернатива геометрии)
`params`	object	Нет	Параметры источника и вывода
`блоки`	множество	Нет	Включенные блоки рабочего процесса

Примечание

*Укажите либо геометрию, либо areaSqKm (или оба).

Example Request

{
  "wdId": "8cb13006-a299-4df6-b47d-91bd63de947f",
  "areaSqKm": 1.5,
  "params": {
    "sourceParams": {
      "dataProvider": {"providerName": "Mapbox"}
    }
  }
}

Пример ответа

Download results

GET /processings/{processingId}/result

Downloads processing results as GeoJSON.

Query Parameters:

aoiId (необязательно) — Фильтровать результаты по определенному AOI

Example

curl https://api.mapflow.ai/rest/processings/{id}/result \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o results.geojson

Download results by AOI

GET /processings/{processingId}/result?aoiId={aoiId}

Downloads processing results as GeoJSON by specific AOI.

Query Parameters:

aoiId (обязательно) — идентификатор AOI, используемый для фильтрации результатов.

Example

curl "https://api.mapflow.ai/rest/processings/{id}/result?aoiId={aoiId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o results_aoi.geojson

Processing management

Restart processing

POST/processings/{processingId}/restart

Перезапускает только неисправные разделы.

Update processing

PUT /processings/{processingId}

{
  "name": "New name",
  "description": "Updated description",
  "projectId": "new-project-uuid"
}

Delete processing

DELETE /processings/{processingId}

Deletes processing and all child entities.

Пользователь и учетная запись

Get user status

GET /user/status

Возвращает сведения об учетной записи, доступные модели и определения рабочих процессов.

Пример ответа

{
  "user": {
    "id": "user-uuid",
    "email": "user@example.com",
    "credits": 5000
  },
  "models": [
    {
      "id": "model-uuid",
      "name": "🏠 Buildings",
      "pricePerSqKm": 15.0,
      "blocks": [...]
    }
  ]
}

Processing history

POST /обработки/статистика

Возвращает историю обработки с нумерацией страниц и фильтрацией.

Query Parameters:

type (необязательно) — Формат ответа: JSON или CSV

Request Body:

Parameter	Тип	Описание
`страница`	целое число	Номер страницы
`на страницу`	целое число	Элементов на странице
`сортировка`	нить	Выражение сортировки (например, `"created:desc"`)
`фильтр`	нить	Выражение фильтра (например, `"status=OK"`)

Example Request

{
  "page": 1,
  "perPage": 50,
  "sort": "created:desc",
  "filter": "status=OK"
}

Источники данных

Объект sourceParams указывает, где получить изображения. Выберите один вариант:

Default Data Provider

Используйте встроенные поставщики, такие как Mapbox, ArcGIS.

{
  "sourceParams": {
    "dataProvider": {
      "providerName": "Mapbox",
      "zoom": 18
    }
  }
}

Поле	Описание
`имя_провайдера`	Имя провайдера: Mapbox, arcgis_world_imagery и т. д.
`масштаб`	Уровень масштабирования (обычно 17–19 для разрешения 0,5 м)

Мои изображения

Используйте изображения, загруженные через API данных Mapflow.

Одно изображение:

{
  "sourceParams": {
    "myImagery": {
      "imageIds": ["image-uuid"]
    }
  }
}

Мозаика (несколько изображений):

{
  "sourceParams": {
    "myImagery": {
      "imageIds": ["img1-uuid", "img2-uuid"],
      "mosaicId": "mosaic-uuid"
    }
  }
}

Поиск изображений

Ищите и используйте изображения от коммерческих поставщиков.

{
  "sourceParams": {
    "imagerySearch": {
      "dataProvider": "maxar",
      "imageIds": ["image-uuid"],
      "zoom": 18
    }
  }
}

Пользовательский URL-адрес

Используйте свой собственный сервис плиток XYZ/TMS/WMS.

{
  "sourceParams": {
    "userDefined": {
      "sourceType": "XYZ",
      "url": "https://tiles.example.com/{z}/{x}/{y}.png",
      "zoom": 18,
      "crs": "EPSG:3857",
      "rasterLogin": "username",
      "rasterPassword": "password"
    }
  }
}

Поле	Тип	Описание
`sourceType`	нить	`XYZ`, `TMS`, `QUADKEY`, `SENTINEL_L2A`, `LOCAL`
`URL`	нить	Шаблон URL-адреса плитки
`масштаб`	целое число	Уровень zoom
`crs`	нить	Система координат (например, `EPSG:3857`)
`rasterLogin`	нить	Необязательное имя пользователя для аутентификации
`rasterPassword`	нить	Дополнительный пароль аутентификации

Загрузка пользовательских изображений

Use API данных Mapflow to create a mosaic and upload images
Ссылка на загруженные изображения в sourceParams.myImagery.imageIds

{
  "params": {
    "sourceParams": {
      "myImagery": {
        "imageIds": ["uploaded-image-uuid"]
      }
    }
  }
}

API данных

Mosaics

Мозаика – это коллекция изображений с географической привязкой, организованная для обработки и предварительного просмотра. Мозаика помогает при работе с несколькими аэрофотоснимками, охватывающими определенную территорию, или при группировании больших ортокарт для оптимизации облачного хранения.

Create Mosaic

ПОСТ/растры/мозаика

Создает пустую коллекцию мозаики.

Request Body

Parameter	Тип	Необходимый	Описание
`имя`	нить	Да	Название мозаики
`теги`	множество	Нет	Теги для организации мозаики

Example Request

curl -X POST https://api.mapflow.ai/rest/rasters/mosaic \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Aerial Survey 2024",
    "tags": ["agriculture", "spring"]
  }'

Response

{
  "id": "6ee95ae6-f26e-41bd-8cb1-39bea545119f",
  "name": "Aerial Survey 2024",
  "tags": ["agriculture", "spring"],
  "created_at": "2024-03-15T10:30:00Z"
}

Get Mosaic

GET /rasters/mosaic/{mosaic_id}

Извлекает метаданные мозаики по идентификатору.

Response

{
  "id": "6ee95ae6-f26e-41bd-8cb1-39bea545119f",
  "name": "Aerial Survey 2024",
  "tags": ["agriculture", "spring"],
  "created_at": "2024-03-15T10:30:00Z",
  "image_count": 15
}

Update Mosaic

PUT /rasters/mosaic/{mosaic_id}

Обновляет имя и теги мозаики.

Request Body

Parameter	Тип	Необходимый	Описание
`имя`	нить	Нет	New mosaic name
`теги`	множество	Нет	Новый список тегов (заменяет существующий)

Example Request

curl -X PUT https://api.mapflow.ai/rest/rasters/mosaic/{mosaic_id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Survey Name",
    "tags": ["agriculture", "summer"]
  }'

Upload Images to Mosaic

POST /rasters/mosaic/{mosaic_id}/image

Uploads georeferenced image files to an existing mosaic.

Внимание

Все изображения в мозаике должны иметь:

Та же система отсчета координат (CRS)
Такое же количество полос
То же пространственное разрешение

Request

Тип контента: multipart/form-data
Тело: поле file с файлом изображения.

Example Request

curl -X POST https://api.mapflow.ai/rest/rasters/mosaic/{mosaic_id}/image \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/orthophoto.tif"

Response

{
  "id": "6ae7f9e9-da2d-41e0-b16f-83396003af57",
  "mosaic_id": "6ee95ae6-f26e-41bd-8cb1-39bea545119f",
  "filename": "orthophoto.tif",
  "file_size": 68417439,
  "uploaded_at": "2024-03-15T10:35:00Z"
}

Create Mosaic and Upload Image

POST /rasters/mosaic/image?name={name}&tags={tag1}&tags={tag2}

Creates a mosaic and uploads an image in a single request.

Example Request

curl -X POST 'https://api.mapflow.ai/rest/rasters/mosaic/image?name=QuickSurvey&tags=test' \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/image.tif"

Link External Image to Mosaic

POST /rasters/mosaic/{mosaic_id}/link-image

Связывает существующий URL-адрес изображения S3 с мозаикой без загрузки.

Request Body

Parameter	Тип	Необходимый	Описание
`URL`	нить	Да	URL-адрес S3 файла изображения

Example Request

curl -X POST https://api.mapflow.ai/rest/rasters/mosaic/{mosaic_id}/link-image \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "s3://bucket/path/image.tif"
  }'

Response

{
  "message": "File successfully linked to a mosaic",
  "mosaic_id": "6ee95ae6-f26e-41bd-8cb1-39bea545119f"
}

Get Images in Mosaic

GET /rasters/mosaic/{mosaic_id}/image

Перечисляет все изображения в мозаике с метаданными.

Response

[
  {
    "id": "6ae7f9e9-da2d-41e0-b16f-83396003af57",
    "filename": "area-1101712.tif",
    "file_size": 68417439,
    "uploaded_at": "2024-03-15T10:35:00Z",
    "footprint": "POLYGON((1.9915 48.7643, ...))",
    "preview_url_s": "https://api.mapflow.ai/rest/rasters/image/{id}/preview/s",
    "preview_url_l": "https://api.mapflow.ai/rest/rasters/image/{id}/preview/l",
    "meta_data": {
      "crs": "EPSG:32631",
      "width": 5589,
      "height": 4079,
      "count": 3,
      "pixel_size": [0.3, 0.3]
    }
  }
]

Delete Mosaic

УДАЛИТЬ /растры/мозаика/{mosaic_id}

Удаляет мозаику и все связанные с ней изображения.

Предупреждение

Это действие необратимо. Все изображения, связанные с мозаикой, будут удалены без возможности восстановления.

Example Request

curl -X DELETE https://api.mapflow.ai/rest/rasters/mosaic/{mosaic_id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Images

Управляйте отдельными файлами изображений и метаданными.

Get Image Metadata

GET /rasters/image/{image_id}

Получает подробные метаданные для определенного изображения.

Response

{
  "id": "6ae7f9e9-da2d-41e0-b16f-83396003af57",
  "filename": "orthophoto.tif",
  "file_size": 68417439,
  "uploaded_at": "2024-03-15T10:35:00Z",
  "footprint": "POLYGON((...))",
  "meta_data": {
    "crs": "EPSG:32631",
    "width": 5589,
    "height": 4079,
    "count": 3,
    "dtypes": ["uint8", "uint8", "uint8"],
    "pixel_size": [0.3, 0.3]
  },
  "cog_link": "s3://bucket/path/cog/image.tif"
}

Обновить имя изображения

PUT /rasters/image/{image_id}?name={new_name}

Обновляет отображаемое имя изображения.

Example Request

curl -X PUT 'https://api.mapflow.ai/rest/rasters/image/{image_id}?name=Updated%20Name' \
  -H "Authorization: Bearer YOUR_TOKEN"

Delete Image

УДАЛИТЬ/растры/изображение/{image_id}

Удаляет изображение из хранилища.

Example Request

curl -X DELETE https://api.mapflow.ai/rest/rasters/image/{image_id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Image Preview

GET /rasters/image/{image_id}/preview/{size}

Получает миниатюру предварительного просмотра изображения.

Path Parameters

Размер	Описание
`с`	Небольшой превью (256×256 пикселей)
`л`	Большой предварительный просмотр (1024×1024 пикселей)

Example Request

curl https://api.mapflow.ai/rest/rasters/image/{image_id}/preview/s \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o preview.jpg

Response

Возвращает данные изображения JPEG.

Хранилище

Получить использование хранилища

`` ПОЛУЧИТЬ /растры/память``

Возвращает текущее использование хранилища и ограничения для вашей учетной записи.

Example Request

curl https://api.mapflow.ai/rest/rasters/memory \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "used_bytes": 5368709120,
  "limit_bytes": 10737418240,
  "used_gb": 5.0,
  "limit_gb": 10.0,
  "usage_percent": 50.0
}

Каталог изображений

Примечание

API поиска изображений соединяет вас с внешними поставщиками спутниковых изображений. Результаты поиска зависят от поставщиков, связанных с вашей учетной записью. Свяжитесь со службой поддержки, чтобы добавить доступ провайдера.

Search Available Imagery

ПОСТ/каталог/мета

Поиск спутниковых изображений от внешних поставщиков по площади и фильтрам метаданных.

Request Body

Parameter	Тип	Необходимый	Описание
`аой`	object	Да	GeoJSON Полигон или Мультиполигон
`acquisitionDateFrom`	нить	Нет	Дата и время в формате UTC (ISO 8601)
`acquisitionDateTo`	нить	Нет	Дата и время в формате UTC (ISO 8601)
`minResolution`	плавать	Нет	Минимальное разрешение (метры/пиксель)
`maxResolution`	плавать	Нет	Максимальное разрешение (метры/пиксель)
`maxCloudCover`	плавать	Нет	Максимальная облачность (0,0-100)
`minOffNadirAngle`	плавать	Нет	Минимальный угол отклонения от надира (градусы)
`maxOffNadirAngle`	плавать	Нет	Максимальный угол отклонения от надира (градусы)
`minAoiIntersectionPercent`	плавать	Нет	Минимальное перекрытие AOI (0,0–100)
`предел`	целое число	Нет	Максимальное количество результатов (по умолчанию: 100)
`смещение`	целое число	Нет	Смещение нумерации страниц
`сортировать по`	нить	Нет	Поле сортировки (например, `ACQUISITION_DATE`)
`sortOrder`	нить	Нет	`ASC` или `DESC`
`скрытьНедоступно`	логическое значение	Нет	Исключить недоступные товары
`провайдеры данных`	множество	Нет	Фильтровать по имени поставщика
`типы продуктов`	множество	Нет	Фильтровать по типам продуктов `["ИЗОБРАЖЕНИЕ" и/или "МОЗАИКА"]`

Предупреждение

Размер области поиска ограничен пределом AOI вашей учетной записи.

Example Request

curl -X POST https://api.mapflow.ai/rest/catalog/meta \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aoi": {
      "type": "Polygon",
      "coordinates": [[[76.6755,43.2234],[76.6755,43.4712],
                       [77.0163,43.4712],[77.0163,43.2234],
                       [76.6755,43.2234]]]
    },
    "acquisitionDateFrom": "2024-01-01T00:00:00Z",
    "acquisitionDateTo": "2024-03-01T00:00:00Z",
    "maxCloudCover": 10.0,
    "maxResolution": 0.5,
    "limit": 10,
    "sortBy": "ACQUISITION_DATE",
    "sortOrder": "DESC"
  }'

Ответ – продукт сцены

[
  {
    "id": "JL1GF03A_PMS_20220607132729_200087596_103_0002_001_L1",
    "productType": "Scene",
    "acquisitionDate": "2022-06-07T13:27:33Z",
    "sensor": "JL1GF03A",
    "pixelResolution": 1.06,
    "cloudCover": 0.09,
    "offNadirAngle": -3.91,
    "colorBandOrder": "B,G,R,NIR,PAN",
    "providerName": "CG",
    "previewType": "png",
    "previewUrl": "https://example.com/preview.jpg",
    "footprint": {
      "type": "Polygon",
     "coordinates": [[[76.5009, 43.3412]]]
    }
  }
]

Ответ – Мозаика

[
  {
    "id": "JL1KF01A_PMS04_20220717131252_200093089_101_0005_001_L1",
    "productType": "Mosaic",
    "acquisitionDate": "2022-07-17T00:00:00Z",
    "sensor": "JL1KF01A",
    "pixelResolution": 0.0,
    "cloudCover": 0.0,
    "offNadirAngle": 3.0,
    "colorBandOrder": "RGB",
    "providerName": "CG_mosaic_2022",
    "previewType": "xyz",
    "previewUrl": "https://app.mapflow.ai/tiles/provider/{z}/{x}/{-y}.png",
    "footprint": {
      "type": "MultiPolygon",
     "coordinates": [[[[76.9037, 43.2529]]]]
    }
  }
]

Использовать результаты поиска при обработке

Чтобы запустить обработку изображений из результатов поиска, используйте исходный параметр imagerySearch:

{
  "params": {
    "sourceParams": {
      "imagerySearch": {
        "dataProvider": "CG_mosaic_2022",
        "imageIds": ["JL1KF01A_PMS04_20220717131252_200093089_101_0005_001_L1"]
      }
    }
  }
}

Полный рабочий процесс обработки см. в документе Processing API.

Типы продуктов

Тип	Описание
Сцена	Захват одного спутника. Доступен для заказа по запросу. Свяжитесь со службой поддержки, чтобы заказать конкретные сцены.
Mosaic	Предварительно обработанная мозаика изображений. Доступно для мгновенной обработки, если провайдер привязан к вашей учетной записи.

Preview Sizes

Код размера	Размеры
`с`	256×256 пикселей
`л`	1024×1024 пикселей

Блоки рабочего процесса

Настройте обработку, включив/отключив дополнительные этапы рабочего процесса.

{
  "blocks": [
    {"name": "Simplification", "enabled": false},
    {"name": "Classification", "enabled": true}
  ]
}

Доступные блоки различаются в зависимости от модели. Получите параметры через GET /user/status.

Модели искусственного интеллекта

Модель	Описание	Разрешение	Увеличить	Дополнительные блоки
🏠 Здания	Создание контуров с классификацией	0,5 м/пиксель	17-18	Simplification, Classification, OSM
🏠 Buildings (Aerial)	Аэрофотоснимки высокого разрешения (10 см/пикселей)	0,1 м/пиксель	19-20	Упрощение
🌲 Лес	Обнаружение древесного покрова	0,5 м/пиксель	17-18	Высоты
🚗 Дороги	Извлечение дорожной сети	0,5 м/пиксель	17-18	—
🏗️ Строительство	Construction site detection	0,5 м/пиксель	17-18	—

Подробные требования см. в описании модели.

Status Codes

Status	Описание
`НЕОБРАБОТАННЫЙ`	Processing created but not started
`В_ПРОГРЕСС`	Processing is running
`ОЖИДАНИЕ`	Ожидание изображений от поставщика
`ОК`	Обработка успешно завершена
`НЕУДАЧА`	Обработка не удалась (проверьте поле `messages`)
`ОТМЕНЕН`	Обработка отменена пользователем
`ВОЗВРАТ`	Кредиты возвращены администратором

Review Status

Review Status	Описание
`ПРИНЯТО`	Результаты приняты
`НЕ_ПРИНЯТО`	Результаты отклонены
`ВОЗВРАТ`	Кредиты возвращены
`IN_REVIEW`	На рассмотрении команды

Error Messages

For detailed error codes and troubleshooting, see Error Messages.

Распространенные ошибки:

source-validator.PixelSizeTooHigh — слишком низкое разрешение изображения (максимум 1,2 м/пиксель).
source-validator.NoDataInAOI — Нет доступных изображений для AOI
geometry.Invalid — Неверная геометрия GeoJSON

Лучшие практики

Проверьте стоимость перед запуском — используйте /processing/cost/v2 для оценки кредитов.
Эффективный опрос статуса — Проверяйте статус каждые 30–60 секунд для обработки IN_PROGRESS.
Обработка ошибок корректно — проверьте поле messages в неудачных обработках.
Используйте соответствующие уровни масштабирования — подбирайте масштаб в соответствии с требованиями модели (обычно 17–18).
Проверка геометрии – убедитесь, что GeoJSON действителен и не слишком велик (< 100 км²).
Организация с помощью проектов — группировка связанных обработок в проектах.
Сохранение идентификаторов обработки – сохранение идентификаторов для последующего получения результатов.

Поддерживать

Rate Limits

В настоящее время нет строгих ограничений по ставкам
Одновременные обработки ограничены уровнем учетной записи
Свяжитесь со службой поддержки в случае большого объема использования.

Получить помощь

Электронная почта: help@geoalert.io
Документация: https://docs.mapflow.ai.
Веб-приложение: https://app.mapflow.ai.