v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB

Capabilities

Information about the back-end

Lists general information about the back-end, including which version and endpoints of the openEO API are supported. May also include billing information.

get/

Response

Information about the API version and supported endpoints / features.

This endpoint MUST always be available for the API to be valid.

api_version'1.3.0' required

Version number of the openEO API specification the back-end implements.

backend_versionstring required

Version number of the back-end implementation. Every change on back-end side MUST cause a change of the version number.

stac_versionstring required

The version of the STAC specification, which MAY not be equal to the STAC API version. The openEO API allows for the STAC versions 1.x.x (RECOMMENDED) and 0.9.x (DEPRECATED).

type'Catalog' required

idstring required

Identifier for the service. This field originates from STAC and is used as unique identifier for the STAC catalog available at /collections.

titlestring required

The name of the service.

descriptionstring commonmark required

A description of the service, which allows the service provider to introduce the user to its service. CommonMark 0.29 syntax MAY be used for rich text representation.

conformsTostring[] required

Lists all conformance classes specified in various standards that the implementation conforms to. Conformance classes are commonly used in all OGC API standards and the STAC API specification.

The general openEO conformance class is https://api.openeo.org/1.3.0. See the individual openEO API extensions for their conformance classes.

productionboolean

Specifies whether the implementation is ready to be used in production use (true) or not (false). Clients SHOULD only connect to non-production implementations if the user explicitly confirmed to use a non-production implementation. This flag is part of GET /.well-known/openeo and GET /. It MUST be used consistently in both endpoints.

Example response

{
  "backend_version": "1.1.2",
  "stac_version": "1.1.0",
  "type": "Catalog",
  "id": "cool-eo-cloud",
  "title": "Example Cloud Corp.",
  "description": "This service is provided to you by [Example Cloud Corp.](https://cloud.example). It implements the full openEO API and allows to process a range of 999 EO data sets, including \n\n* Sentinel 1/2/3 and 5\n* Landsat 7/8\n\nA free plan is available to test the service. For further information please contact our customer service at [support@cloud.example](mailto:support@cloud.example).",
  "conformsTo": [
    "https://api.openeo.org/1.3.0",
    "https://api.openeo.org/extensions/commercial-data/0.1.0",
    "https://api.openeo.org/extensions/federation/0.2.0",
    "https://api.stacspec.org/v1.0.0/core",
    "https://api.stacspec.org/v1.0.0/collections"
  ],
  "endpoints": [
    {
      "path": "/collections",
      "methods": [
        "GET"
      ]
    },
    {
      "path": "/collections/{collection_id}",
      "methods": [
        "GET"
      ]
    },
    {
      "path": "/processes",
      "methods": [
        "GET"
      ]
    },
    {
      "path": "/jobs",
      "methods": [
        "GET",
        "POST"
      ]
    },
    {
      "path": "/jobs/{job_id}",
      "methods": [
        "GET",
        "DELETE",
        "PATCH"
      ]
    }
  ],
  "billing": {
    "currency": "USD",
    "default_plan": "free",
    "plans": [
      {
        "name": "free",
        "description": "Free plan. Calculates one tile per second and a maximum amount of 100 tiles per hour.",
        "url": "https://cloud.example/plans/free-plan",
        "paid": false
      },
      {
        "name": "premium",
        "description": "Premium plan. Calculates unlimited tiles and each calculated tile costs 0.003 USD.",
        "url": "https://cloud.example/plans/premium-plan",
        "paid": true
      }
    ]
  },
  "links": [
    {
      "href": "https://cloud.example",
      "rel": "about",
      "type": "text/html",
      "title": "Homepage of the service provider"
    },
    {
      "href": "https://cloud.example/tos",
      "rel": "terms-of-service",
      "type": "text/html",
      "title": "Terms of Service"
    },
    {
      "href": "https://cloud.example/privacy",
      "rel": "privacy-policy",
      "type": "text/html",
      "title": "Privacy Policy"
    },
    {
      "href": "https://cloud.example/register",
      "rel": "create-form",
      "type": "text/html",
      "title": "User Registration"
    },
    {
      "href": "https://cloud.example/lost-password",
      "rel": "recovery-form",
      "type": "text/html",
      "title": "Reset Password"
    },
    {
      "href": "https://cloud.example/.well-known/openeo",
      "rel": "version-history",
      "type": "application/json",
      "title": "List of supported openEO versions"
    },
    {
      "href": "https://cloud.example/api/v1/conformance",
      "rel": "conformance",
      "type": "application/json",
      "title": "OGC Conformance Classes"
    },
    {
      "href": "https://cloud.example/api/v1/collections",
      "rel": "data",
      "type": "application/json",
      "title": "List of Datasets"
    },
    {
      "href": "https://editor.openeo.org",
      "rel": "web-editor",
      "type": "text/html",
      "title": "openEO Web Editor",
      "version": "0.14.0"
    }
  ]
}