.. Copyright (C) 2021-2025 SpaceKnow, Inc.

.. _api.scene-tasking:

*****************
Scene Tasking API
*****************

* URL: https://api.spaceknow.com/scene-tasking

Scene Tasking API can be used to order captures of a given polygon via provider tasking.

Each :docs:`Order<redoc.html#tag/Scene-Tasking/operation/Get_Order_scene_tasking_orders_get_post>`  can contain several
:docs:`Captures<redoc.html#tag/Scene-Tasking/operation/Get_Capture_scene_tasking_captures_get_post>`  of the given polygon.
Each Order Capture can consist of one or several scenes. (The polygon could be captured
as several scenes for Planet provider.)
When an Order Capture is marked as "fulfilled" the Scene Tasking API will automatically
ingest the scenes to Phoenix catalog and notifies the owner of the order. The ingested
scenes IDs will then appear in the Order Capture document.

Users of this API are able to:

* Create, update, and cancel Tasking Orders
* Get the status of their orders and check the collection progress
* Get the scene IDs of the captured images

See full :docs:`Scene Tasking API reference<redoc.html#tag/Scene-Tasking>` API reference.

.. _api.scene-tasking.providers:

Available Providers
===================

+-----------------+-----------------+-------------------+---------------+
| Provider        | API name        | Datasets          | API Status    |
+-----------------+-----------------+-------------------+---------------+
| ``Planet``      | ``pl``          | ``SkySatCollect`` | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Satellogic``  | ``satellogic``  | ``newsat_sr``     | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Satellogic``  | ``satellogic``  | ``newsat_basic``  | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Umbra``       | ``umbra``       | ``spotlight_GEC`` | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Iceye``       | ``iceye``       | ``Stripmap_GRD``  | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Iceye``       | ``iceye``       | ``Spotlight_GRD`` | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Airbus``      | ``ab``          | ``pleiades``      | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Airbus``      | ``ab``          | ``pleiades-neo``  | ``connected`` |
+-----------------+-----------------+-------------------+---------------+
| ``Airbus``      | ``ab``          | ``spot``          | ``connected`` |
+-----------------+-----------------+-------------------+---------------+

Planet
------
Can have multiple scenes in a single capture. SpaceKnow is providing a result of the
tasked scene as a 5km circle AOI around requested centroid.
See: `Planet Tasking`_.

.. _Planet Tasking: https://developers.planet.com/docs/tasking/

Satellogic
----------
See: `Satellogic Tasking`_.

.. _Satellogic Tasking: https://developers.satellogic.com/tasking-service/description.html

Umbra
-----
Tasks 5x5km2 8bit SAR imagery with resolution of 0.35m/px around requested centroid.
See: `Umbra Tasking`_.

.. _Umbra Tasking: https://docs.canopy.umbra.space/docs/tasking

Iceye
-----

Currently Stripmap_GRD(30x50km 2.5m/px) and Spotlight_GRD(5x5km 0.5m/px) tasking is connected.
Tasking is done around requested centroid.
See: `Iceye Tasking`_.

.. _Iceye Tasking: https://platform.iceye.com/docs/tasking

Airbus
------

Airbus Tasking is connected through Up42.

See: `Airbus Up42 Pleiades`_, `Airbus Up42 Pleiades Neo`_ and `Airbus Up42 Spot`_.

.. _Airbus Up42 Pleiades: https://docs.up42.com/data/datasets/pleiades
.. _Airbus Up42 Pleiades Neo: https://docs.up42.com/data/datasets/pleiades-neo
.. _Airbus Up42 Spot: https://docs.up42.com/data/datasets/spot