Skip to main content
Euca exposes one typed HTTP API. Everything an agent does — build, play, experiment — goes through it. The endpoint pages in this section are generated from the live request and response types in the engine, so they track the real code.

​
Conventions

  • Base URL — http://localhost:3917 for a local server.
  • Content type — send Content-Type: application/json on every request with a body.
  • Identifiers — entities are addressed by id; pass the generation returned by /spawn alongside the id where an endpoint asks for it.
  • Clients — it is plain JSON over HTTP, so any language works. Examples are shown in cURL, Python (requests), and Rust (reqwest).

​
Authentication

The local, self-hosted server is unauthenticated — run it in a trusted environment. Hosted or benchmark access, where it exists, is gated by a plain API key at the hosting layer, not by the engine. A login route appears in this reference for hosted deployments that opt into it; it is optional and not required to use the engine locally.

​
Coverage

This reference documents the full HTTP surface — all 121 endpoints — across world, simulation, rules, forks, snapshots, scenes & scenarios, gameplay, inventory & economy, heroes, assertions & manifest, camera & render, UI, animation, audio, particles, terrain, navigation, input, scripting, and AI asset generation. It is generated directly from the live request/response types in the handlers, so it tracks the real code. Engine version: 1.2.0.