CLI

pipelines

Manage cloud pipelines, runs, batches and reviews (preview)

Pipelines are in preview, and Editframe enables them for each organization. Until they are enabled for your organization, every pipeline request returns 404. To ask for access, email hello@editframe.com. The commands can change without notice.

Manage pipelines and pipeline runs in Editframe's cloud. Unlike the other commands, pipelines calls the cloud API directly: it needs no local runtime, and it does not use --project, --bridge or the other runtime options.

bash

export EDITFRAME_TOKEN="$EDITFRAME_API_KEY"
npx editframe pipelines create speech-check --definition speech-check.json
npx editframe pipelines runs create PIPELINE_ID FILE_ID --watch

Requests authenticate with the API key in EDITFRAME_TOKEN. The host is --host, then EDITFRAME_HOST, then https://editframe.com. editframe pipelines --help prints the full usage.

Commands

Command	Description
`list [--include-archived]`	List pipelines
`get PIPELINE_ID`	Show a pipeline and its latest version
`create NAME --definition FILE.json`	Create a pipeline with version 1
`archive PIPELINE_ID`	Archive a pipeline
`versions list PIPELINE_ID`	List versions
`versions get PIPELINE_ID VERSION`	Show one version
`versions create PIPELINE_ID --definition FILE.json`	Create a version, or find the version with the same definition
`endpoints list [--include-archived]`	List endpoints
`endpoints get ENDPOINT_ID`	Show an endpoint
`endpoints create URL [--header "Name: value"]... [--timeout-ms N] [--callback-timeout-ms N] [--max-concurrency N]`	Register an endpoint. The signing secret is printed once.
`endpoints archive ENDPOINT_ID`	Archive an endpoint
`runs create PIPELINE_ID FILE_ID [--version N] [--external-id ID] [--idempotency-key KEY] [--watch]`	Start a run
`runs list [--status S] [--pipeline-id ID] [--file-id ID] [--batch-id ID]`	List runs, newest first
`runs get RUN_ID [--watch]`	Show a run and its steps
`runs cancel RUN_ID`	Cancel a run
`runs retry RUN_ID [--watch]`	Retry a failed or cancelled run
`runs outputs RUN_ID NAMESPACE`	Show the outputs a run wrote to a namespace
`batches create PIPELINE_ID [FILE_ID...] [--files IDS.txt] [--version N] [--max-in-flight N] [--external-id ID] [--idempotency-key KEY]`	Start one run for each file
`batches list [--status running\|completed] [--pipeline-id ID]`	List batches
`batches get BATCH_ID`	Show a batch and its run counts
`reviews list [--status pending\|approved\|rejected\|expired] [--run-id ID] [--pipeline-id ID]`	List reviews, oldest first
`reviews get REVIEW_ID`	Show a review
`reviews approve REVIEW_ID [--patch FILE.json]`	Approve a review, with optional corrections
`reviews reject REVIEW_ID [--reason TEXT]`	Reject a review
`upload FILE [--run PIPELINE_ID] [--version N] [--watch] [--resume FILE_ID] [--fragment-duration SECONDS] [--concurrency N]`	Upload a video as verified fragments, and optionally start a run on it
`metadata FILE_ID [NAMESPACE]`	List the namespaces pipelines wrote on a file, or show one

Options

Option	Description
`--json`	Print API responses as JSON
`--host URL`	API host (default: `EDITFRAME_HOST` or `https://editframe.com`)
`--limit N`	Page size for lists and outputs (1–100)
`--cursor CURSOR`	Continue a list from the next cursor of a previous page
`--watch`	Poll the run until it finishes. Exits with status 1 when the run fails or is cancelled.

Notes

A --files file has one file ID per line. Text after # is ignored.
A --patch file is { "annotations": [...], "reviewed_kinds": [...] }. See Approve.
upload --run starts the run as soon as the file exists, so segment steps process fragments as they arrive. Its default idempotency key is derived from the file, the pipeline and the version, so --resume finds the same run. When an upload stops, the CLI prints the command that resumes it.