Skip to main content
How-to guideApplies to: Unified engine deployments
Each reference page lists its method, path, parameters, JSON body, response, and error behavior. The server remains authoritative for permissions and semantic rules.

Paths, query values, and bodies

Path values select a resource. Query values filter or page a response. JSON bodies define an operation’s input. The reference describes each field and its location. Identifiers returned by the engine belong in later path fields. Encode each path component in your client. For catalog discovery, namespace is a JSON array encoded as a query string, such as ["analytics", "daily"]; a dot inside a component is not a separator. Send JSON bodies with Content-Type: application/json. Do not add fields from a response object unless the request schema accepts them. Many request types reject unknown fields.

Shared types

Read units and bounds on the specific field. Do not assume every timestamp or duration uses the same representation. Large integer handling also depends on the domain: typed workload parameter values can preserve supported integers as strings; arbitrary integer fields are not automatically string-valued.

Example values

Complete examples use {{name}} placeholders. Replace each one in your client before sending a request. Preserve the field’s JSON type when substituting a number, object, or string. Successful responses supply named values for later requests. Record these IDs and use them in the later path fields or request bodies. UUID placeholders need a fresh UUID for new work; preserve the original UUID when recovering the same request.
Last modified on November 4, 2026