Skip to content

Process API

Transport

AgentBox exposes this service through the Connect protocol over HTTP. The AgentBox SDK supplies the routing and authorization headers automatically.

  • Production base URL: https://sandbox.agentbox-runtime.ru
  • Fully qualified service: process.Process
  • RPC URL pattern: POST https://sandbox.agentbox-runtime.ru/process.Process/{RPC}

Request headers

  • Agentbox-Sandbox-Id · required — Sandbox identifier.
  • Agentbox-Sandbox-Port · required — Envd port routed by the sandbox proxy. Default: 49983.
  • X-Access-Token · conditional — Sandbox-scoped envd access token, when one was issued.

List

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/List
  • Request: ListRequest
  • Response: ListResponse

Connect

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/Connect
  • Request: ConnectRequest
  • Response: stream ConnectResponse

Start

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/Start
  • Request: StartRequest
  • Response: stream StartResponse

Update

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/Update
  • Request: UpdateRequest
  • Response: UpdateResponse

StreamInput

Client input stream ensures ordering of messages

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/StreamInput
  • Request: stream StreamInputRequest
  • Response: StreamInputResponse

SendInput

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/SendInput
  • Request: SendInputRequest
  • Response: SendInputResponse

SendSignal

Public RPC exposed by envd.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/SendSignal
  • Request: SendSignalRequest
  • Response: SendSignalResponse

CloseStdin

Close stdin to signal EOF to the process. Only works for non-PTY processes. For PTY, send Ctrl+D (0x04) instead.

  • Endpoint: POST https://sandbox.agentbox-runtime.ru/process.Process/CloseStdin
  • Request: CloseStdinRequest
  • Response: CloseStdinResponse

Message types

PTY

FieldTypeNumberDescription
sizeSize1

PTY.Size

FieldTypeNumberDescription
colsuint321
rowsuint322

ProcessConfig

FieldTypeNumberDescription
cmdstring1
argsrepeated string2
envsmap<string, string>3
cwdoptional string4

ListRequest

ProcessInfo

FieldTypeNumberDescription
configProcessConfig1
piduint322
tagoptional string3

ListResponse

FieldTypeNumberDescription
processesrepeated ProcessInfo1

StartRequest

FieldTypeNumberDescription
processProcessConfig1
ptyoptional PTY2
tagoptional string3
stdinoptional bool4This is optional for backwards compatibility. We default to true. New SDK versions will set this to false by default.

UpdateRequest

FieldTypeNumberDescription
processProcessSelector1
ptyoptional PTY2

UpdateResponse

ProcessEvent

FieldTypeNumberOneofDescription
startStartEvent1event
dataDataEvent2event
endEndEvent3event
keepaliveKeepAlive4event

ProcessEvent.StartEvent

FieldTypeNumberDescription
piduint321

ProcessEvent.DataEvent

FieldTypeNumberOneofDescription
stdoutbytes1output
stderrbytes2output
ptybytes3output

ProcessEvent.EndEvent

FieldTypeNumberDescription
exit_codesint321
exitedbool2
statusstring3
erroroptional string4

ProcessEvent.KeepAlive

StartResponse

FieldTypeNumberDescription
eventProcessEvent1

ConnectResponse

FieldTypeNumberDescription
eventProcessEvent1

SendInputRequest

FieldTypeNumberDescription
processProcessSelector1
inputProcessInput2

SendInputResponse

ProcessInput

FieldTypeNumberOneofDescription
stdinbytes1input
ptybytes2input

StreamInputRequest

FieldTypeNumberOneofDescription
startStartEvent1event
dataDataEvent2event
keepaliveKeepAlive3event

StreamInputRequest.StartEvent

FieldTypeNumberDescription
processProcessSelector1

StreamInputRequest.DataEvent

FieldTypeNumberDescription
inputProcessInput2

StreamInputRequest.KeepAlive

StreamInputResponse

SendSignalRequest

FieldTypeNumberDescription
processProcessSelector1
signalSignal2

SendSignalResponse

CloseStdinRequest

FieldTypeNumberDescription
processProcessSelector1

CloseStdinResponse

ConnectRequest

FieldTypeNumberDescription
processProcessSelector1

ProcessSelector

FieldTypeNumberOneofDescription
piduint321selector
tagstring2selector

Enum types

Signal

ValueNumberDescription
SIGNAL_UNSPECIFIED0
SIGNAL_SIGTERM15
SIGNAL_SIGKILL9