Skip to main content
POST
Create Environment

Authorizations

Authorization
string
header
required

A Kite API key (kite_...), from Platform API → Keys in the dashboard.

Headers

Kite-Version
enum<string>
default:2026-09-27

The dated contract your code was written against. Without it you get 2026-09-27; every response says which version served it.

Available options:
2026-09-27

Body

application/json
name
string | null
Maximum string length: 160
description
string | null
Maximum string length: 2000
usd_uri
string | null
glb_uri
string | null
upload
UploadSpec · object | null
object_min_z
number | null

z (m) below which a dropped object counts as fallen; default -0.2

spawn_zones
Spawn Zones · object[]

[{name?, x, y, z?, radius?}] where objects may be placed

initial_pose
Initial Pose · object | null

{position_xyz:[x,y,z], rotation_xyzw?:[x,y,z,w]}

up_axis
string | null

'Y' or 'Z' — how the geometry is authored

rotate_deg
number[] | null

extra [rx, ry, rz] rotation in degrees

Response

Successful Response