Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

CreateProcessRequest

Type: object

CreateProcessRequest starts an interactive process.
cmd · required

Type: array

cmd is the argv vector.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "cmd is the argv vector.",
  "items": {
    "type": "string"
  },
  "minItems": 1,
  "type": "array"
}
env

Type: object

env adds environment variables.
All schema constraints and annotations
{
  "additionalProperties": {
    "title": "value",
    "type": "string"
  },
  "description": "env adds environment variables.",
  "type": "object"
}
label

Type: string | null

(OPTIONAL) label is unique within the sandbox; omission retains the server-generated default.
All schema constraints and annotations
{
  "description": "(OPTIONAL) label is unique within the sandbox; omission retains the server-generated default.",
  "minLength": 1,
  "type": [
    "string",
    "null"
  ]
}
pty

Schema: PtyConfig

pty requests a pseudo-terminal; absence uses separate stdin/stdout/stderr pipes.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/PtyConfig",
  "description": "pty requests a pseudo-terminal; absence uses separate stdin/stdout/stderr pipes."
}
session

Type: string

session is an optional opaque session tag stored verbatim; empty means untagged.
All schema constraints and annotations
{
  "description": "session is an optional opaque session tag stored verbatim; empty means untagged.",
  "type": "string"
}
user

Type: string

user is the user to run as.
All schema constraints and annotations
{
  "description": "user is the user to run as.",
  "type": "string"
}
workingDir

Type: string

working_dir is the process working directory.
All schema constraints and annotations
{
  "description": "working_dir is the process working directory.",
  "type": "string"
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "CreateProcessRequest starts an interactive process.",
  "properties": {
    "cmd": {
      "description": "cmd is the argv vector.",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "type": "array"
    },
    "env": {
      "additionalProperties": {
        "title": "value",
        "type": "string"
      },
      "description": "env adds environment variables.",
      "type": "object"
    },
    "label": {
      "description": "(OPTIONAL) label is unique within the sandbox; omission retains the server-generated default.",
      "minLength": 1,
      "type": [
        "string",
        "null"
      ]
    },
    "pty": {
      "$ref": "#/components/schemas/PtyConfig",
      "description": "pty requests a pseudo-terminal; absence uses separate stdin/stdout/stderr pipes."
    },
    "session": {
      "description": "session is an optional opaque session tag stored verbatim; empty means untagged.",
      "type": "string"
    },
    "user": {
      "description": "user is the user to run as.",
      "type": "string"
    },
    "workingDir": {
      "description": "working_dir is the process working directory.",
      "type": "string"
    }
  },
  "required": [
    "cmd"
  ],
  "title": "CreateProcessRequest",
  "type": "object"
}