Workflows¶
The tables below list the types and functions available through the Workflows API. For information on how these objects work together, check out out the Workflows Guide.
Request Access
Workflows is currently in limited release. To request access please make a request through our support portal.
Geospatial
Proxy GeoJSON Feature representing a 

Proxy GeoJSON FeatureCollection constructed from a sequence of Features. 

Proxy 

Proxy GeoJSON Geometry representing a geometry’s type and coordinates. 

Proxy GeoJSON GeometryCollection constructed from a sequence of Geometries. 

Proxy Image; construct with 

Proxy object representing a stack of Images; typically construct with 

Dictlike object for a grouped 

A Kernel is a proxy object holding the kernel when performing a 2dimensional convolution. 



2D spatial convolution of an 

Create a Workflows 

Create a Workflows 

Returns an 
Array
Proxy Array representing a multidimensional, homogenous array of fixedsize items. 

Proxy MaskedArray representing a multidimensional, homogenous array of fixedsize items that may have missing or invalid entries. 
NumPy Functions
Workflows exposes a large chunk of the NumPy API. Either use the workflows.numpy
submodule (preferred), or pass Workflows Array
or MaskedArray
objects into NumPy functions directly.
See NumPy Functions for a full list of available functions.
Primitives
Proxy wrapper around a Python primitive type. 

Represents a proxy object of an unknown type. 

Proxy type(None). 

Proxy boolean. 

Abstract base class for numeric Proxytypes. 

Proxy integer. 

Proxy float. 

Proxy string. 
Containers








Returns a 
Datetimes
Proxy Datetime object, similar to Python’s datetime. 

Proxy Timedelta object, similar to Python’s timedelta. 
Function

Math
Elementwise natural log of an 

Elementwise base 2 log of an 

Elementwise base 10 log of an 

Elementwise log of 1 + an 

Elementwise square root of an 

Elementwise exponential of an 

Elementwise square of an 

Elementwise cosine of an 

Elementwise inverse cosine of an 

Elementwise sine of an 

Elementwise inverse sine of an 

Elementwise tangent of an 

Elementwise inverse tangent of an 

Elementwise arc tangent of 
Constants
e = 2.71828182845904523536028747135266249775724709369995… 

Floating point representation of positive infinity. 

Floating point representation of Not a Number. 

pi = 3.1415926535897932384626433… 
Interactive
A single 

Browse shared 

Subclass of 

Widget displaying a map, layers, and output logs in a nicer layout. 

Subclass of 

An 

Widget displaying a list of 

Parameters for a 

Display pixel values when clicking on the map. 

Widget displaying a UI for browsing and searching 
Parameter
Create a typed parameter. 
Conditionals
An ifelse statement: returns 
Execution
A collection of versions of a proxy object, with associated metadata. 

A 

Stores proxy objects to be rendered by an XYZ tile server. 

Calls callback functions in a background thread when XYZ errors occur. 

Compute a proxy object and wait for its result. 

Publish a proxy object as a 

Use like 
Output Formats
Workflows exposes a number of serialization formats for results. Use the format
argument to compute
to specify a format.
Output Destinations
Workflows exposes a number of destinations for results. Use the destination
argument to compute
to specify a destination.
Result Types
Result of calling 

Result of calling 

Result of calling 
Exceptions
Raised when an operation is applied to an inappropriate ProxyType, similar to a Python’s TypeError. 

Generic error raised when a job computation fails. 


Raised when a job computation runs out of memory. 

Raised when a job computation fails due to invalid authentication. 

Raised when a job computation is invalid. 

Raised when a job computation fails due to an operation being applied to an inappropriate type. 

Raised when a job takes too long to compute (currently 30 mins). 

Raised when a job computation is terminated before finishing. 

Raised when a job computation is interrupted before finishing. 
Raised when a computation took longer to complete than a specified timeout. 


Raised when a job is cancelled. 

Raised when job result serialization fails. 
gRPC Client
Lowlevel gRPC client for interacting with the Workflows backend. 