Create world manifest job

POST

/api/v1/org/{org}/ws/{workspace}/worlds/manifests

curl --request POST \
  --url https://example.com/api/v1/org/example/ws/example/worlds/manifests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "domains": [ "example" ], "name": "example", "num_hosts": 1, "num_users": 1, "preset": "small", "project_id": "example", "seed": 1 }'

Authorizations

• OAuth2PasswordBearer
• APIKeyCookie
• APIKeyHeader

Parameters

Path Parameters

org

required

Org

Organization slug

string

Organization slug

workspace

required

Workspace

Workspace slug

string

Workspace slug

Request Body ^required

Media type application/json

CreateWorldManifestRequest

Create a workspace-scoped world manifest generation job.

object

domains

Any of:

Array<string>

Array<string>

null

null

name

Any of:

string

string

null

null

num_hosts

Any of:

integer

integer

>= 1 <= 10000

null

null

num_users

Any of:

integer

integer

>= 1 <= 50000

null

null

preset

Any of:

string

string

Allowed values: small medium large enterprise

null

null

project_id

Any of:

string

string format: uuid4

null

null

seed

Any of:

integer

integer

null

null

Responses

202

Successful Response

Media type application/json

WorldJobResponse

Shared job response for Worlds async operations.

object

cancel_requested_at

Any of:

string

string

null

null

completed_at

Any of:

string

string

null

null

created_at

required

Created At

string

created_by

Any of:

string

string

null

null

created_by_user

Any of:

UserIdentityResponse

UserIdentityResponse

Small denormalized user identity for cross-domain byline display.

object

email

required

Email

string

full_name

Any of:

string

string

null

null

id

required

Id

string format: uuid

username

required

Username

string

null

null

error

Any of:

string

string

null

null

id

required

Id

string

kind

required

Kind

string

Allowed values: manifest_generation trajectory_generation

organization_id

required

Organization Id

string

progress

Any of:

number

number

<= 1

null

null

project_id

Any of:

string

string

null

null

resource_id

Any of:

string

string

null

null

resource_type

Any of:

string

string

Allowed values: manifest trajectory trajectory_batch

null

null

result

Result

object

key

additional properties

any

started_at

Any of:

string

string

null

null

status

required

Status

string

Allowed values: queued running completed failed cancelled

workspace_id

required

Workspace Id

string

Example

{
  "kind": "manifest_generation",
  "resource_type": "manifest",
  "status": "queued"
}

400

Invalid request

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

401

Authentication failed

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

403

Access forbidden

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

404

Not found

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

409

Already exists

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

422

Validation error

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

426

Upgrade required

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

429

Rate limited

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

500

Internal server error

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

502

Bad gateway

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

504

Gateway timeout

Media type application/json

APIErrorPayload

Canonical API error envelope returned by the API.

object

code

required

Code

HTTP status code

integer

Allowed values: 400 401 403 404 409 422 426 429 500 502 504

detail

required

Detail

Human-readable error message

string

errors

Any of:

Array<object>

Array<object>

ValidationErrorItem

object

loc

required

Loc

Where the validation error occurred

Array

msg

required

Msg

Human-readable validation message

string

type

required

Type

Machine-readable validation error type

string

null

null

type

required

Type

Stable machine-readable error type

string

Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error token_error upgrade_required_error usage_limit_exceeded_error user_verification_error validation_error

Example

{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}