Skip to main content
The Platform API is the control-plane interface used by the RevoEngine UI, CLI, SDK discovery, and customer integrations. It manages definitions and state; configured HTTP endpoints are invoked through the separate Endpoint runtime.

​
Current contract

This reference is generated from the RevoEngine OpenAPI 1.3.0 specification. It covers current API families including:
  • users, service accounts, groups, roles, and API keys;
  • components, runtime revisions, and deployments;
  • endpoints and generated endpoint OpenAPI;
  • databases, views, cache, audit, and data operations;
  • Storage, upload sessions, downloads, and previews;
  • jobs, templates, schedules, events, event history, and webhooks;
  • chat, Assistant threads, Agents, memory, and plugins;
  • activity, search, secrets, preferences, and instance configuration.
Use the generated operation page for exact parameters and request schemas. Use the guides for workflow, lifecycle, and failure semantics.

​
Base URL

Production and private deployments can expose different hostnames. Use the Platform API URL supplied for your instance. Examples use:

​
Request checklist

  1. Send an API key or platform session token in the Authorization header.
  2. Send Content-Type: application/json for JSON request bodies.
  3. With a platform session token, include the instance identifier required by the operation.
  4. With an instance-bound API key, let the key resolve its instance; if an instance header is also sent, it must match.
  5. Record the returned resource, execution, operation, job, thread, or run identifier for later diagnostics.

Authentication

Errors and status codes

The OpenAPI contract is the exhaustive route inventory. Some flexible response payloads are intentionally less specific than their request DTOs; inspect the operation description and the related product guide before coupling to optional fields.
Last modified on September 5, 2026