Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
Data Processing

Process and download data synchronously

Executes a user-defined process directly (synchronously) and the result will be downloaded in the format specified in the process graph. This endpoint can be used to generate small previews or test user-defined processes before starting a batch job. Timeouts on either client-side or server-side are to be expected for complex computations. Back-ends MAY send the openEO error ProcessGraphComplexity immediately if the computation is expected to time out. Otherwise requests MAY time-out after a certain amount of time by sending openEO error RequestTimeout. A header named OpenEO-Costs MAY be sent with all responses, which MUST include the costs for processing and downloading the data. Additionally, a link to a log file MAY be sent in the header.

post/result

Request body

budgetnumber nullable

Maximum amount of costs the request is allowed to produce. The value MUST be specified in the currency of the back-end. No limits apply, if the value is null or the back-end has no currency set in GET /.

planstring nullable

The billing plan to process and charge the job or service with.

Billing plans MUST be accepted in a case insensitive manner. Back-ends MUST resolve the billing plan in the following way:

  • If a non-null value is given: Persist the plan that has been provided in the request.
  • Otherwise:
    1. Persist the default_plan exposed through GET /me, if available.
    2. Persist the default_plan exposed through GET /, if available.
    3. If a single plan is exposed by the back-end, persist it.
    4. Otherwise, the back-end MUST throw a BillingPlanMissing error.

The resolved plan MUST be persisted permanently, regardless of any changes to the exposed billing plans in GET / in the future.

Billing plans not on the list of available plans MUST be rejected with openEO error BillingPlanInvalid.

log_level'error' | 'warning' | 'info' | 'debug'

The minimum severity level for log entries that the back-end stores for the processing request.

The order of the levels is as follows (from low to high severity): debug, info, warning, error. That means if warning is set, the back-end will only store log entries with the level warning and error.

The default minimum log level is info. Users need to specifically set this property to debug to capture all log entries. It is RECOMMENDED that users set the level at least to "warning" in production workflows.

Response

Result data in the requested output format