Skip to main content

Discovery and Metadata

Flux provides a set of _meta endpoints that let you programmatically explore what data is available through a service, inspect dataset schemas, and access interactive API documentation — all without needing to know the full URL structure in advance.

All _meta endpoints are served under:

https://compute.earthmover.io/v1/services/{deployment_name}/{org}/_meta/

Where {deployment_name} is the name of your Flux service (e.g. tiles, edr) and {org} is your Arraylake organization.

These endpoints respect the same authentication rules as the rest of your service. See Authentication for details.

Discovery

The discovery endpoints let you walk the hierarchy of repos, refs, and datasets available through a service.

List Repositories

Returns the names of all repositories accessible within the organization.

GET /services/{deployment_name}/{org}/_meta/discovery
curl -u {org}:{api_key} \
"https://compute.earthmover.io/v1/services/{deployment_name}/{org}/_meta/discovery"
["my-repo", "another-repo"]

List Branches and Tags

Returns the branches and tags available for a given repository.

GET /services/{deployment_name}/{org}/_meta/discovery/{repo}
curl -u {org}:{api_key} \
"https://compute.earthmover.io/v1/services/{deployment_name}/{org}/_meta/discovery/{repo}"
{"branches": ["main", "dev"], "tags": ["v1.0"]}

List Datasets

Returns the dataset groups available at a given branch or tag. Flux identifies a group as a dataset if it contains any arrays.

GET /services/{deployment_name}/{org}/_meta/discovery/{repo}/{ref}
curl -u {org}:{api_key} \
"https://compute.earthmover.io/v1/services/{deployment_name}/{org}/_meta/discovery/{repo}/{ref}"
["temperature", "wind/gust", "wind/speed"]

You can also scope the search to a sub-group with the group query parameter:

GET /services/{deployment_name}/{org}/_meta/discovery/{repo}/{ref}?group=wind

Dataset Info

The dataset info endpoints let you inspect the schema and contents of a dataset without loading any array data. These accept an optional {group} path segment to target a sub-group within the repository.

Dataset Schema

Returns dimensions, variable types, and global attributes for a dataset.

GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/info
GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/{group}/info
curl -u {org}:{api_key} \
"https://compute.earthmover.io/v1/services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/info"
{
"dimensions": {"time": 365, "latitude": 721, "longitude": 1440},
"variables": {
"temperature": {
"type": "float32",
"dimensions": ["time", "latitude", "longitude"],
"attributes": {"units": "K", "long_name": "Temperature"}
}
},
"global_attributes": {"Conventions": "CF-1.6"}
}

Variable Keys

Returns the list of all variable names in the dataset.

GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/keys
GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/{group}/keys
["time", "latitude", "longitude", "temperature"]

Dataset Dictionary

Returns the full dataset structure as a dictionary (without data values).

GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/dict
GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/{group}/dict

HTML Representation

Returns an interactive HTML representation of the dataset (the same view as xarray's repr_html).

GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}
GET /services/{deployment_name}/{org}/_meta/datasets/{repo}/{ref}/{group}

Visit this URL in a browser to see a rich, expandable view of the dataset's variables, dimensions, and attributes.

API Documentation

Each service exposes interactive API documentation through the _meta endpoints. These show all available routes with the correct path parameters for your service.

EndpointDescription
/_meta/docsSwagger UI — interactive API explorer
/_meta/redocReDoc — alternative API documentation
/_meta/openapi.jsonRaw OpenAPI schema (JSON)

For example, to explore the API for a tiles service:

https://compute.earthmover.io/v1/services/tiles/{org}/_meta/docs