Skip to main content
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"
)

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

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

class Client(url: str, token: str)
Create a Tilebox workflows client.

​
Parameters

​
url
string
Tilebox API Url. Defaults to https://api.tilebox.com.
​
token
string
The API Key to authenticate with. If not set the TILEBOX_API_KEY environment variable will be used.

​
Sub clients

The workflows client exposes sub clients for interacting with different parts of the Tilebox workflows API. 
def Client.jobs() -> JobClient
A client for interacting with jobs. 
def Client.clusters() -> ClusterClient
A client for managing clusters. 
def Client.automations() -> AutomationClient
A client for scheduling automations.

​
Task runners

def Client.runner(...) -> TaskRunner
A client is also used to instantiate task runners. Check out the Client.runner API reference for more information. 
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"
)

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

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