SpawnRequest (what you set when creating an entity)
and RichEntityData (what you get back from observe).
The generated API reference is the authoritative schema. It’s
generated from the handlers, so it never drifts.
GET /schema returns a short hand-maintained
component summary and is superseded by the OpenAPI document — use the API reference for exact
field types.What you can spawn — SpawnRequest
POST /spawn accepts these fields (all optional):
What you observe — RichEntityData
POST /observe (and GET /entities/{id}) return entities as:
entity_id via the
segmentation channel (see Datasets).
Core component types
The lowest-level components (GET /schema):
| Component | Shape |
|---|---|
LocalTransform | position [x,y,z], rotation [x,y,z,w], scale [x,y,z] |
GlobalTransform | read-only; computed from the hierarchy on /step |
Velocity | linear [x,y,z], angular [x,y,z] |
PhysicsBody | Dynamic | Static | Kinematic |
Collider | Aabb(hx,hy,hz) | Sphere(r) (plus capsule/convex/trimesh/compound internally) |
Health, Team, … | gameplay components (Gameplay & combat) |
Transforms read
[0,0,0] until the first /step — GlobalTransform propagates on step. A
velocity only integrates if the entity has a physics_body.Authoritative schemas
Every request/response struct, generated from the handlers.