Skip to content

Command line examples

A pre-requisite for exchanging requests with the various Tasking API endpoints is to have a valid authentication token and contract_id, see Authentication API. In the examples below, the headers in the requests have placeholders for token and contract_id.

Get product list

Retrieve a list of the products available for tasking.1

Request

curl --location --request GET 'https://api.satellogic.com/tasking/products/' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID"

Response

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "pk": 169,
            "name": "Multispectral 70cm",
            "is_area": false
        },
        {
            "pk": 178,
            "name": "Area Coverage 70cm",
            "is_area": true
        },
    ]
}

Get task list

Retrieve a list of the tasks submitted under the contract. 1

Request

curl --location --request GET 'https://api.satellogic.com/tasking/tasks/?limit=100&offset=0' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID"

Response

{
    "count": 9876,
    "next": "https://api.satellogic.com/tasking/tasks/?limit=100&offset=100",
    "previous": null,
    "results": [
        {
            "task_id": 2488,
            "task_name": "Bush Gardens",
            "project_name": "Theme parks",
            "product": 1,
            "start": "2019-10-24T00:00:00Z",
            "end": "2019-10-31T00:00:00Z",
            "priority": 14,
            "client": "Amusement Corp",
            "target": {
                "type": "Point",
                "coordinates": [
                    -120.087111,
                    34.74643,
                    0.0
                ]
            },
            "created_time": "2018-09-12T21:55:06.221076Z",
            "status": "received"
        },
...

Get filtered task list

Retrieve a list of the tasks submitted under the contract applying supported filters.1

The list can be filtered by task_name and status.

Request

curl --location --request GET 'https://api.satellogic.com/tasking/tasks/?task_name=Perito%20Moreno%20Glacier&status=completed' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID"

Response

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "task_id": 212581,
            "task_name": "Perito Moreno Glacier",
            "project_name": "National Parks",
            "product": 90,
            "start": "2024-04-22T00:00:00Z",
            "end": "2024-05-06T23:59:00Z",
            "priority": 14,
            "client": "National Parks",
            "target": {
                "type": "Point",
                "coordinates": [
                    -73.03691447180972,
                    -50.47102624812482,
                    193.0076446533203
                ]
            },
            "created_time": "2024-04-22T15:38:24.348683+00:00",
            "status": "completed"
        },
}

Submit new task

Submit a new task by specifying product, point of interest and time period.

Request

curl --location --request POST 'https://api.satellogic.com/tasking/tasks/' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID" \
--header 'Content-Type: application/json' \
--data-raw '{
    "task_name": "Disney Land",
    "project_name": "Theme parks",
    "product": 90,
    "target": {
        "type": "Point",
        "coordinates": [
            72.905273,
            19.023001
        ]
    },
    "start": "2025-06-12T00:00:00",
    "end": "2025-06-23T00:00:00"
}'

Response

{
    "task_id": 299029,
    "task_name": "Disney Land",
    "project_name": "Theme parks",
    "product": 90,
    "start": "2025-06-12T00:00:00Z",
    "end": "2025-06-23T00:00:00Z",
    "priority": 13,
    "client": "Amusement Corp",
    "target": {
        "type": "Point",
        "coordinates": [
            72.905273,
            19.023001,
            36.67431259155273
        ]
    },
    "created_time": "2025-05-20T14:11:59.932721+00:00",
    "status": "received"
}

Get task status

Retrieve status and metadata associated with a task.

Request

curl --location --request GET 'https://api.satellogic.com/tasking/tasks/299029/' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID"

Response

{
    "task_id": 299029,
    "task_name": "Disney Land",
    "project_name": "Theme parks",
    "product": 90,
    "start": "2025-06-12T00:00:00Z",
    "end": "2025-06-23T00:00:00Z",
    "priority": 13,
    "client": "Amusement Corp",
    "target": {
        "type": "Point",
        "coordinates": [
            72.905273,
            19.023001,
            36.67431259155273
        ]
    },
    "created_time": "2025-05-20T14:11:59.932721+00:00",
    "status": "received"
}

Get capture list

Retrieve the list of captures associated with a task.1

Request

curl --location --request GET 'https://api.satellogic.com/tasking/tasks/212581/captures/' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID"

Response

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "capture_id": "abe88c71-45c5-49e2-93a2-0b22e6c5bf69",
            "start": "2021-02-12T13:24:09.749209Z",
            "satellite_name": "newsat13",
            "status": "published"
        },
        {
            "capture_id": "0b1230b7-51eb-4b2b-a672-f40da25a81f4",
            "start": "2021-02-13T13:36:46.797424Z",
            "satellite_name": "newsat18",
            "status": "processing"
        },
        {
            "capture_id": "fcee0909-1746-4d33-b8a6-0108afd62634",
            "start": "2021-02-15T13:31:23.181541Z",
            "satellite_name": "newsat13",
            "status": "queued"
        }
    ]
}

The response will contain an element in results for every capture planned on behalf of the task.

The attributes for each capture are the following:

Parameter Type Description
capture_id string Unique identifier for the capture. This identifier is the same as outcome_id.
start ISO Datetime Datetime indicating when the capture took place
satellite_name string Name of the satellite executing the capture
status string The capture status. See Captures statuses for more details.
fragment_id UUID Unique identifier for the area fragment. Available for AOI tasks only

Cancel a Task

Cancel a submitted task. The task will appear in the task list with Canceledstatus.

Request

curl --location --request PATCH 'https://api.satellogic.com/tasking/tasks/299029/cancel/' \
--header "authorizationToken: Bearer $ACCESS_TOKEN" \
--header "X-Satellogic-Contract-Id: $CONTRACT_ID"

Response

{
    "task_id": 299029,
    "task_name": "Disney Land",
    "project_name": "Theme parks",
    "product": 90,
    "start": "2025-06-12T00:00:00Z",
    "end": "2025-06-23T00:00:00Z",
    "priority": 13,
    "client": "Amusement Corp",
    "target": {
        "type": "Point",
        "coordinates": [
            72.905273,
            19.023001,
            36.67431259155273
        ]
    },
    "created_time": "2025-05-20T14:11:59.932721+00:00",
    "status": "canceled"
}

  1. All the GET endpoints intended to obtain a list (get products list, get tasks list for current contract, get captures list for a task) support the parameters limit and offset which enable the navigation of paginated results.