API docs by Redocly

Tesseract API (v1.0.1)

Download OpenAPI specification:Download

The Tesseract API is a service to get spatiotemporal data in an analysis ready format and to run arbitrary models on combinations of this data. A Tesseract is the 4 dimensional generalization of a cube. A tesseract as returned by this service has 4 dimensions: (time, feature/band, x, y). Within the SeerAI view of the connected spatiotemporal world, this is a common way of looking at data.

submit a tesseract job

Builds a TesseractJob, returning the dataset object created, a STAC item, and some status about the job.

Authorizations:
auth0
Request Body schema: application/json

Description of the tesseract requested. Can be derived from multiple datasets.

name
string

Tesseract creates a dataset in Entanglement. This lets you set the name of this dataset. If a dataset with this name already exists, it will be overwritten (a new version will be added).

alias
string

The alias of the dataset created by this job.

description
string

A text description of the Job. This description is text-searchable in Entanglement.

domain
string
Default: "*"

The domain qualifier of the output dataset when it gets added to the graph

category
string
Default: "*"

The category qualifier of the output dataset when it gets added to the graph

type
string
Default: "*"

The type qualifier of the output dataset when it gets added to the graph

bbox
Array of numbers [ 4 .. 6 ] items

The spatial extent of the job. Entire area will be processed if there is data. This can be refined further by providing a geometry in addition to or instead of the bbox. The output extent of the dataset will become the bbox, if provided regardless of whether the geometry is smaller or not.

bbox_epsg
integer

The spatial reference EPSG code for the bbox

output_epsg
integer

The spatial reference EPSG code for the output. Pixel sizes will be in this spatial reference

pointGeoJSON (object) or multipointGeoJSON (object) or linestringGeoJSON (object) or multilinestringGeoJSON (object) or polygonGeoJSON (object) or multipolygonGeoJSON (object) or geometrycollectionGeoJSON (object) (geometryGeoJSON)
project
string

The project that this job will be created in. The resulting Dataset will be accessible from that project. The user must have write access for the specified project (can be either the project name for project id).

dry_run
boolean

Perform a dry run instead of submitting the job. Good to check for errors that crop up before executing a large job. (default False)

workers
integer

The number of workers to use for this job (default 1)

object (bucket)
Array of objects (step)

This is where the bulk of a job should be specified. An arbitrary DAG can be specified here which can be composed of create-assets steps that transform data into the needs of the job, as well as other steps that perform transformations on this data. If the step is of type model. A container image must be specified that performs transformations on the dataset.

Array of objects (hook)
object
Deprecated
Array of objects (asset_spec)
Deprecated

Responses

Request samples

Content type
application/json
{
  • "bbox": [
    ],
  • "bbox_epsg": 4326,
  • "output_epsg": 3857,
  • "steps": [
    ]
}

Response samples

Content type
application/json
{}

List jobs

List jobs for specified project

Authorizations:
auth0
query Parameters
search
string

search term which matches job name, alias or description

project
required
string

the project to search for jobs in

Responses

Get job

Get a specific job by job id or name in a given project

Authorizations:
auth0
path Parameters
job_id
required
string

the id/name of the job requested

query Parameters
project
required
string

the project to search for the job in

Responses

Delete Job

Deletes a specific job in a given project

Authorizations:
auth0
path Parameters
job_id
required
string

the id of the job to delete

query Parameters
project
required
string

the project for the specified job

remove_data
boolean

If true the data will be removed from the output destination

Job Status

get the status for a job

Authorizations:
auth0
path Parameters
job_id
required
string
query Parameters
project
required
string

the project to search for jobs in

return_quark_status
boolean

Returns the status of the individual quarks. Note that on large jobs this can create a large response

return_quark_geoms
boolean

Returns the geometry of the quarks

return_alerts
boolean

Returns any alerts the job may have produced during planning or execution since the last submit

Responses

Response samples

Content type
application/json
{
  • "job_status": {
    }
}

Get the Dataset for this job

Get the Dataset definition for this job. This is stored separately from entanglement and only refers to the current version.

Authorizations:
auth0
path Parameters
job_id
required
string
query Parameters
project
required
string

the project to search for jobs in

Responses

Response samples

Content type
application/json
{
  • "dataset": { }
}

Get the STAC Item for this job

Get the STAC item representing this job and its outputs.

Authorizations:
auth0
path Parameters
job_id
required
string
query Parameters
project
required
string

the project to search for jobs in

Responses

Response samples

Content type
application/json
{}