Custom blocks

Analytics platform discontinued after January 31, 2024

The current analytics platform will be discontinued after January 31, 2024, and will be replaced by new advanced processing functionalities. This change will affect projects, workflows, jobs, data blocks, processing blocks, and custom blocks. For more information, see the blog post.

Overview

Custom blocks are processing blocks created by users that can be used in workflows. Before publishing a custom block, first validate the block manifest against the block schema definition.

Validate a block manifest

To validate a block manifest, call the /validate-schema/block endpoint.

Request

POST /validate-schema/block HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}

See request example

{
  "_up42_specification_version": 2,
  "name": "orbital_pleiades_trucks",
  "display_name": "Truck Detection",
  "description": "This is a processing block that detects trucks on 1232x1232 GeoTIFF images",
  "type": "processing",
  "tags": ["analytics", "detection", "machine learning", "object"],
  "machine": {
    "type": "gpu_nvidia_tesla_k80"
  },
  "parameters": {
    "bbox": {
      "type": "array",
      "default": null
    },
    "contains": {
      "type": "geometry"
    },
    "intersects": {
      "type": "geometry"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "default": 1
    },
    "time": {
      "type": "dateRange",
      "default": "2018-01-01T00:00:00+00:00/2020-12-31T23:59:59+00:00"
    },
    "zoom_level": {
      "type": "integer",
      "default": 17
    },
    "ids": {
      "type": "array",
      "default": null
    }
  },
  "input_capabilities": {
    "raster": {
      "up42_standard": {
        "processing_level": "l1"
      }
    }
  },
  "output_capabilities": {
    "vector": {
      "up42_standard": {
        "format": "GeoJSON",
        "geometry_type": "Point"
      },
      "custom": {
        "object_type": "truck"
      }
    }
  },
  "optional_features": {
    "quicklook_supported": true,
    "dry_run_supported": true
  }
}

Response

See response example

{
  "data": {
    "valid": true,
    "error": []
  },
  "error": null
}