Open console
Home/UP42 API/Workflows

Manage workflows

See, edit, and delete workflows using the API.

See workflows

To see a list of a specific project's workflows, call the /projects/{project_id}/workflows endpoint with your project ID as a path parameter.

Request

GET /projects/{project_id}/workflows HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response


See response example
{
  "data": [
    {
      "id": "ca057572-c7c3-4982-83f7-054761ddbfc3",
      "name": "Sentinel-2 Super-resolution",
      "description": "Runs a deep learning-based super-resolution algorithm on a Sentinel-2 image to create an image with 10 m resolution.\n",
      "createdAt": "2021-04-14T13:19:08.931748Z",
      "updatedAt": "2021-04-14T13:19:45.361612Z",
      "createdBy": {
        "id": "system",
        "type": "INTERNAL"
      },
      "updatedBy": {
        "id": "d3a1dc7e-926e-44b3-be1d-739d2152860e",
        "type": "USER"
      },
      "totalProcessingTime": 0
    }
  ],
  "error": null
}

ParameterOverview
data.idstring
The workflow ID.
data.namestring
The name of the workflow.
data.descriptionstring
A description of the workflow.
data.createdAtstring
The timestamp when the workflow was created.
data.updatedAtstring
The timestamp when the workflow was last updated.
data.createdByobject
Information about the user who performed the action.
data.createdBy.idstring
The ID of the user who performed the action.
data.createdBy.typestring
The type of the user who performed the action.
data.updatedByobject
Information about the user who performed the action.
data.updatedBy.idstring
The ID of the user who performed the action.
data.updatedBy.typestring
The type of the user who performed the action.
data.totalProcessingTimeinteger
The total duration of the processing time for the workflow.

See workflow details

To see information about one workflow in a project, call the /projects/{project_id}/workflows/{workflow_id} endpoint with your project ID and the workflow ID as path parameters.

Request

GET /projects/{project_id}/workflows/{workflow_id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

The response is an object from the /projects/{project_id}/workflows data array.


See response example
{
  "data": {
    "id": "7a436b4a-4974-423a-8606-b80ba3e64b31",
    "name": "Sentinel-2 Super-resolution",
    "description": "Runs a deep learning-based super-resolution algorithm on a Sentinel-2 image to create an image with 10 m resolution.\n",
    "createdAt": "2021-09-27T08:22:08.318901Z",
    "updatedAt": "2021-09-28T12:08:45.378154Z",
    "createdBy": {
      "id": "system",
      "type": "INTERNAL"
    },
    "updatedBy": {
      "id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
      "type": "USER"
    },
    "totalProcessingTime": 0
  },
  "error": null
}

See workflow tasks

To see detailed information about a specific workflow's tasks, call the /projects/{project_id}/workflows/{workflow_id} endpoint with your project ID and the workflow ID as path parameters.

Request

GET /projects/{project_id}/workflows/{workflow_id}/tasks HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response


See response example
{
  "error": null,
  "data": [
    {
      "id": "0479cdb8-99d0-4de1-b0e2-6ff6b69d0f68",
      "displayId": "0479cdb8",
      "createdAt": "2021-09-28T12:08:45.377339Z",
      "updatedAt": "2021-09-28T12:08:45.377339Z",
      "createdBy": {
        "id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
        "type": "USER"
      },
      "updatedBy": {
        "id": "3c97ec1b-be2c-4516-aa80-8f065fc94060",
        "type": "USER"
      },
      "name": "oneatlas-pleiades-display:1",
      "parentsIds": [],
      "blockName": "oneatlas-pleiades-display",
      "blockVersionTag": "1.4.2",
      "block": {
        "id": "6ac78530-6200-42c1-b6a9-381a9f69d8ef",
        "displayId": "6ac78530",
        "createdAt": "2020-11-11T11:55:07.465884Z",
        "updatedAt": "2020-11-11T11:55:07.465884Z",
        "createdBy": {
          "id": "system",
          "type": "INTERNAL"
        },
        "updatedBy": {
          "id": "eff16ad8-7fc3-46c7-b17b-952d7cb14afe",
          "type": "USER"
        },
        "name": "oneatlas-pleiades-display",
        "displayName": "Pléiades Display (Download)",
        "description": "Pléiades imagery in its original DIMAP format. Pan-sharpened RGB and NIR (0.5 m) bands with 8 bits.",
        "containerUrl": "registry.up42.com/marketplace/oneatlas-pleiades-display:d7cJu3wGptLeTChL6eu6kdbmfu96lRwMib1kYags",
        "inputCapabilities": [],
        "outputCapabilities": [],
        "provider": "OneAtlas",
        "providerWebsite": "https://oneatlas.airbus.com/",
        "providerLogoUrl": "https://metadata.up42.com/6ac78530-6200-42c1-b6a9-381a9f69d8ef/Airbus_company_logo1614851240336.jpeg",
        "tags": [
          "Maritime",
          "Oil, Gas, Minerals, and Energy",
          "Optical",
          "Transportation",
          "Infrastructure and Utilities",
          "Satellite",
          "Insurance and Financial Services",
          "Environmental Protection",
          "Global",
          "Land Use and Management",
          "High Revisit",
          "Real Estate",
          "Agriculture"
        ],
        "isPublic": true,
        "isPublicVersion": true,
        "isValid": true,
        "isRestricted": false,
        "isAccessGranted": true,
        "isCreditPurchaseRequired": true,
        "isLimitStreamingDataAccess": false,
        "parameters": {
          "ids": {
            "type": "array",
            "default": null
          },
          "bbox": {
            "type": "array",
            "default": null
          },
          "time": {
            "type": "dateRange",
            "default": "2018-01-01T00:00:00+00:00/2021-12-31T23:59:59+00:00"
          },
          "limit": {
            "type": "integer",
            "default": 1,
            "maximum": 500,
            "minimum": 1
          },
          "contains": {
            "type": "geometry"
          },
          "asset_ids": {
            "type": "array",
            "default": null
          },
          "intersects": {
            "type": "geometry"
          },
          "time_series": {
            "type": "array",
            "default": "string"
          },
          "max_cloud_cover": {
            "type": "integer",
            "default": 100,
            "maximum": 100,
            "minimum": 0
          }
        },
        "type": "DATA",
        "isDryRunSupported": true,
        "version": "1.4.2",
        "metadata": {
          "overview": "Pléiades 1A/1B are very-high resolution twin satellite offering 0.5m resolution products. For more information, please see the [provider website](https://oneatlas.airbus.com/).",
          "termsAndConditionsUrl": "https://metadata.up42.com/6ac78530-6200-42c1-b6a9-381a9f69d8ef/Standard_Licence_Living_Library_-_21.03.191605122252982.pdf",
          "blockThumbnailUrl": "https://metadata.up42.com/6ac78530-6200-42c1-b6a9-381a9f69d8ef/0_Pleiades_1A-1B_Avatar1614851248730.jpg",
          "pricingStrategy": {
            "id": "3b5e4719-917a-468b-9abc-75af8a82a0db",
            "displayId": "3b5e4719",
            "createdAt": "2021-06-21T13:06:43.027042Z",
            "updatedAt": "2021-06-21T13:06:43.027042Z",
            "createdBy": {
              "id": "eff16ad8-7fc3-46c7-b17b-952d7cb14afe",
              "type": "USER"
            },
            "updatedBy": {
              "id": "eff16ad8-7fc3-46c7-b17b-952d7cb14afe",
              "type": "USER"
            },
            "type": "SQUARE_KM_OUTPUT",
            "credits": 1000
          },
          "blockPricingStrategy": {
            "name": "simple",
            "unit": "SQUARE_KM",
            "direction": "OUTPUT"
          },
          "blockMarketplaceSampleData": [
            {
              "id": "3b5e4719-917a-468b-9abc-75af8a82a0db",
              "displayId": "3b5e4719",
              "createdAt": "2021-06-22T13:06:43.027042Z",
              "updatedAt": "2021-06-22T13:06:43.027042Z",
              "createdBy": {
                "id": "eff16ad8-7fc3-46c7-b17b-952d7cb14afe",
                "type": "USER"
              },
              "updatedBy": {
                "id": "eff16ad8-7fc3-46c7-b17b-952d7cb14afe",
                "type": "USER"
              },
              "value": "https://metadata.up42.com/6ac78530-6200-42c1-b6a9-381a9f69d8ef/Pleiades_1A-1B_China_State_of_Jin1614851254852.jpg",
              "type": "IMAGE"
            }
          ]
        },
        "machineName": "SMALL",
        "manifestVersion": 2,
        "capabilities": {
          "input": {},
          "output": {
            "raster": {
              "up42_standard": {
                "bands": ["red", "green", "blue", "nir"],
                "dtype": "uint8",
                "format": "DIMAP",
                "sensor": "Pleiades",
                "resolution": 0.5,
                "processing_level": "l2"
              }
            }
          }
        }
      },
      "environment": "string"
    }
  ]
}

ParameterOverview
data.idstring
The task ID.
data.displayIdstring
The display ID of the workflow task.
data.createdAtstring
The timestamp when the workflow task was created.
data.updatedAtstring
The timestamp when the workflow task was updated.
data.createdByobject
The ID and type of the user who performed the action.
data.createdBy.idstring
The ID of the user who performed the action.
data.createdBy.typestring
The type of user who performed the action.
data.updatedByobject
The ID and type of the user who performed the action.
data.updatedBy.idstring
he ID of the user who performed the action.
data.updatedBy.typestring
The type of user who performed the action.
data.namestring
The name of the workflow task.
data.parentsIdsarray of strings
The IDs of parent workflow tasks.
data.blockNamestring
The name of the block.
data.blockVersionTagstring
The version of the block.
data.blockobject
Detailed information about the block.
data.environmentstring
Information about the environment variables and any run-time parameters that the block should be aware of.

Delete a workflow

To delete a workflow, call the /projects/{project_id}/workflows/{workflow_id} endpoint with your with your project ID and the workflow ID as path parameters.

Request

DELETE projects/{project_id}/workflows/{workflow_id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

If a workflow is deleted successfully, there will be no response body.