Skip to main content
POST
Generate a seed

Authorizations

Authorization
string
header
required

Access token issued by WorkOS AuthKit.

Body

application/json
name
string
required

Display name of the seed

Required string length: 1 - 100
twin
string
required

Slug of the twin this seed is for

Required string length: 1 - 100
prompt
string
required

The starting state you want, in your own words. "50 open tickets, half of them aging past 90 days."

Required string length: 1 - 2000

Response

Successful Response

id
string<uuid>
required
name
string
required
twin
string
required

The twin this seed can be loaded into.

prompt
string
required

The starting state this seed was asked for.

status
string
required

pending, running, ready or failed

usable
boolean
required

Whether the twin's current release can still load this seed. False means the twin's storage changed since it was generated, so it has to be generated again.

created_at
string<date-time>
required
failure
string | null

Why generation failed, if it did.

twin_version
string | null

The release this seed was generated against.

size_bytes
integer | null
completed_at
string<date-time> | null