agnify run

`agnify run create`

Create a draft from a template + a source — optional —start (#73).

Exactly one source is required:

—file PATH upload a local file, then run it —file-id ID an already-uploaded file (repeat for a batch) —vms-video-id ID a recorded VMS video segment (repeat for a batch) —camera cam-… [—profile —from —to] a camera’s recorded footage —presigned-url URL a presigned S3 GET URL — downloaded, re-uploaded, run under a custom worker-built template

--file-id / --vms-video-id / --camera reuse server-side media, so no upload happens. Shares the upload/start helpers with agnify ingest file.

Usage

agnify run create [OPTIONS]

Options

Flag	Description
`--template, -T`	Template id — either a static slug (e.g. ‘video-analysis’) or a UUID returned by `agnify templates save`.
`--file, -f`	Local video file to ingest. Uploaded to /api/v1/files first, then wired into the draft as the VideoSource input.
`--file-id`	Run against an already-uploaded file by id (no re-upload). Repeat for a multi-file batch run. Find ids with `agnify file ls`.
`--vms-video-id`	Run against a recorded VMS video segment by id. Repeat for a multi-segment batch run.
`--camera`	Run against a camera’s recorded footage (cam-… id). Pairs with —profile / —from / —to.
`--presigned-url`	Presigned S3 GET URL to a single video. Downloaded and re-uploaded, then run under a custom —template built on the worker; marks the run for a dedicated runner. The worker pool is chosen server-side from your org.
`--profile`	Camera recording profile to read (with —camera). (default: `main`)
`--from`	Window start (ISO-8601) for —camera footage; omit for no lower bound.
`--to`	Window end (ISO-8601) for —camera footage. Setting it makes the run bounded (s3_batch) and requires —from; omit for an open-ended live poll (s3_stream).
`--name`	Sidebar display name; applies to —file or a single —file-id (other sources are named by the server).
`--start`	After creating the draft, immediately POST /start. Off by default so you can review the snapshot first.

`agnify run delete`

Delete an execution (draft or terminal) and its data. Irreversible.

Allowed for the run’s creator or an owner of its org. Stop an active (running/paused) run first — it is refused otherwise.

Usage

agnify run delete EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

`agnify run events`

List per-wave events for one execution.

See agnify events query --channel for the cross-execution rollup over a named metrics channel.

Usage

agnify run events [OPTIONS] EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

Options

Flag	Description
`--event-type, -t`	Filter by event_type (frame_processed
`--limit, -n`	Max rows (default 50). (default: `50`)
`--offset`	Skip N rows (default 0).

`agnify run ls`

List executions visible to the active org.

Usage

agnify run ls [OPTIONS]

Options

Flag	Description
`--status, -s`	Filter by status (draft
`--camera`	Filter to one camera’s executions (camera id).
`--limit, -n`	Max rows to render (default 50). (default: `50`)

`agnify run restart`

Stop (if active) then start. Convenience wrapper.

Usage

agnify run restart EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

`agnify run results`

Download the aggregated results JSON for one execution.

Wraps GET /api/v1/executions/{id}/results.json.

Usage

agnify run results [OPTIONS] EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

Options

Flag	Description
`--out, -o`	Write to this path instead of stdout.

`agnify run start`

Start a DRAFT / STOPPED / FAILED execution.

Usage

agnify run start EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

`agnify run status`

Show one execution’s current state.

Usage

agnify run status EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

`agnify run stop`

Stop a running or paused execution.

Usage

agnify run stop EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

`agnify run synthesis`

Download the whole-run synthesis a Run Synthesis node produced.

Wraps GET /api/v1/executions/{id}/synthesis.json. The document carries the model’s answer (result for a schema-constrained run, text for a free-form one), the digest it reasoned over, and any synthesis error. 404s when the run carried no Run Synthesis node.

Usage

agnify run synthesis [OPTIONS] EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

Options

Flag	Description
`--out, -o`	Write to this path instead of stdout.

`agnify run wait`

Block until the execution reaches a terminal state.

Exit codes: 0 — completed or stopped (user-driven termination is success) 1 — failed 2 — —timeout reached without a terminal status

Usage

agnify run wait [OPTIONS] EXECUTION_ID

Arguments

Name	Description
`EXECUTION_ID`	Execution UUID, or a unique id prefix (≥4 chars, like a git commit).

Options

Flag	Description
`--interval, -i`	Poll interval in seconds (default 2). (default: `2.0`)
`--timeout, -t`	Give up after this many seconds (default: wait forever).