Run a process

Queues an idle process for execution. Set force to true to rerun a process that already produced output. Set block to true to wait for the process to return to the idle state before responding.

POST /processes/{pid}/signals/run

Run a process

cURL

curl --request POST \
  --url http://localhost:7687/processes/{pid}/signals/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "force": true,
  "block": true
}
'

200

{
  "pid": 1,
  "ref": "<string>"
}

Path Parameters

pid · integer · required

Numeric process identifier.

Required range: x > 0

Body

application/json

Request body used to dispatch a run signal to an existing process.

force · boolean

When true, reruns a process even if prior output already exists.

block · boolean

When true, waits until execution completes before returning.

Response

200

application/json

The queued or completed process snapshot.

Process status snapshot returned by process management endpoints.

pid · integer · required

Numeric process identifier assigned by the API.

Required range: x > 0

state · enum<string> · required

Current lifecycle state of the process.

Available options: idle, queued, running, terminating

status · enum<string> | null · required

Terminal outcome of the process when it reaches the idle state.

Available options: failed, success, timeout, canceled, null

ref · string

Optional caller-supplied reference string used to group related processes.

Minimum string length: 1