Skip to main content
v1

Create a long-lived managed process.

POST /v1/processes: request parameters and responses.

POST /v1/processes

Spawns a new process with the given command and arguments. Supports both pipe-based and PTY (tty) modes. Returns the process descriptor on success.

Request body

Required.

application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProcessCreateRequest"
  }
}

Related schemas: ProcessCreateRequest.

Responses

200

Started process

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProcessInfo"
  }
}

Related schemas: ProcessInfo.

400

Invalid request

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.

409

Process limit or state conflict

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.

501

Process API unsupported on this platform

Content type: application/json

{
  "schema": {
    "$ref": "#/components/schemas/ProblemDetails"
  }
}

Related schemas: ProblemDetails.