Skip to main content
POST
Start a monitor

Path Parameters

sessionId
string<uuid>
required

The session's id.

Body

application/json

A request to run a watcher. Monitors started this way are recorded as the person's; the model starts its own through its tool.

name
string
required

The watcher's name. Bounded to what a URL path segment carries unchanged, because this same name is the address the request that stops the watcher is sent to.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
command
string
required
Required string length: 1 - 4096
filter
string
Maximum string length: 512

Response

The monitor, now running.

One long-running watcher a session is keeping beside its conversation.

name
string
required

Unique within its session; this is what stops it.

command
string
required

What runs, under the session's repository.

startedBy
enum<string>
required

Which hand reached the switch. Both may, and the registry treats them identically; this says which one it was, so the model knows before it stops something it did not start.

Available options:
model,
user
startedAt
string<date-time>
required
filter
string

A regular expression keeping only the output lines that match it. Absent means every line.