Quickstart
This guide helps you set up and get started using Tilebox. It covers how to install a Tilebox client for your preferred language and how to use it to query data from a dataset and run a workflow.
Select your preferred language and follow the steps below to get started.
Start in a Notebook
Explore the provided Sample Notebooks to begin your journey with Tilebox. These notebooks offer a step-by-step guide to using the API and showcase many features supported by Tilebox Python clients. You can also use these notebooks as a foundation for your own projects.
Start on Your Device
If you prefer to work locally, follow these steps to get started.
Install Packages
Install the Tilebox Python packages.
For new projects we recommend using uv. More information about installing the Tilebox Python SDKs can be found in the Installation section.
Create an API Key
Create an API key by logging into the Tilebox Console, navigating to Account -> API Keys, and clicking the “Create API Key” button.
Query Data
Use the datasets client to query data from a dataset.
Run a Workflow
Use the workflows client to create a task and submit it as a job.
Explore Further
Review the following guides to learn more about the modules that make up Tilebox:
Start in a Notebook
Explore the provided Sample Notebooks to begin your journey with Tilebox. These notebooks offer a step-by-step guide to using the API and showcase many features supported by Tilebox Python clients. You can also use these notebooks as a foundation for your own projects.
Start on Your Device
If you prefer to work locally, follow these steps to get started.
Install Packages
Install the Tilebox Python packages.
For new projects we recommend using uv. More information about installing the Tilebox Python SDKs can be found in the Installation section.
Create an API Key
Create an API key by logging into the Tilebox Console, navigating to Account -> API Keys, and clicking the “Create API Key” button.
Query Data
Use the datasets client to query data from a dataset.
Run a Workflow
Use the workflows client to create a task and submit it as a job.
Explore Further
Review the following guides to learn more about the modules that make up Tilebox:
Start with Examples
Explore the provided Examples to begin your journey with Tilebox. These examples offer a step-by-step guide to using the API and showcase many features supported by Tilebox Go clients. You can also use these examples as a foundation for your own projects.
Start on Your Device
If you prefer to work locally, follow these steps to get started.
Install Packages
Add the Tilebox library in your project.
Install tilebox-generate command-line tool on your machine. It’s used to generate Go structs for Tilebox datasets.
Create an API Key
Create an API key by logging into the Tilebox Console, navigating to Account -> API Keys, and clicking the “Create API Key” button.
Query Data
Run tilebox-generate in the root directory of your Go project.
It generates the dataset type for Sentinel-2 MSI dataset. It will generate a ./protogen/tilebox/v1/sentinel2_msi.pb.go
file.
Query Data
Use the datasets client to query data from a dataset.
Run a Workflow
Use the workflows client to create a task and submit it as a job.
Explore Further
Review the following guides to learn more about the modules that make up Tilebox: