Skip to main content
POST
Create Scenario

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
robot
string
required

catalog robot id, e.g. gr1 | g1 | droid | franka

task
string
required

task primitive id, e.g. put_item_in_fridge_and_close_door

name
string | null
Maximum string length: 160
description
string | null
Maximum string length: 2000
embodiment
string | null

Arena embodiment; default = the robot's first embodiment the task accepts

environment
string | null

catalog environment id, or a validated user env_… id; default arena_default

object_set
string | null

catalog object set id

objects
string[]

explicit Arena asset names or validated user obj_… ids (overrides object_set)

env_args
Env Args · object

extra Arena env cfg overrides

variation_axes
string[]
default_max_steps
integer | null
Required range: 100 <= x <= 20000
est_episode_s
number | null
Required range: 0 < x <= 3600
tags
string[]

Response

Successful Response