Client

class Client(
    *,
    url: str = "https://api.tilebox.com",
    token: str | None = None,
    name: str | None = None,
    client_id: UUID | None = None,
    transport: Literal["grpc", "http1"] = "grpc",
)

Copy

Create a Tilebox workflows client.

Parameters

url str

Tilebox API Url. Defaults to https://api.tilebox.com.

token str | None

The API key to authenticate with. If not set, the TILEBOX_API_KEY environment variable is used.

name str | None

Optional service name for workflow telemetry. If not set, the default service name is used.

client_id UUID | None

Optional stable ID used to scope internal loggers. If not set, a random ID is generated.

transport Literal["grpc", "http1"]

Network transport to use for API requests. Defaults to "grpc". Use "http1" to force the Connect protocol over HTTP/1.1 on networks that do not support gRPC over HTTP/2 correctly.

Sub clients

The workflows client exposes sub clients for interacting with different parts of the Tilebox workflows API.

def Client.jobs() -> JobClient

Copy

A client for interacting with jobs.

def Client.clusters() -> ClusterClient

Copy

A client for managing clusters.

def Client.workflows() -> WorkflowClient

Copy

A client for managing workflows and workflow release deployments.

def Client.automations() -> AutomationClient

Copy

A client for scheduling automations.

Logging

def Client.configure_logging(
    level: int | logging.Logger,
    runner_level: int | None = None,
) -> None

Copy

Configure which task and runner logs this client exports. See Client.configure_logging.

Runners

def Client.runner(...) -> TaskRunner

Copy

A client is also used to instantiate runners. Check out the Client.runner API reference for more information.

Request example

Python

from tilebox.workflows import Client

# read token from an environment variable
client = Client()

# or provide connection details directly
client = Client(
    url="https://api.tilebox.com",
    token="YOUR_TILEBOX_API_KEY",
    name="sentinel-2-runner",
)

# access sub clients
job_client = client.jobs()
cluster_client = client.clusters()
workflow_client = client.workflows()
automation_client = client.automations()

# or instantiate a runner
runner = client.runner(tasks=[...])

Copy