diff --git a/cli/ci-cd.mdx b/cli/ci-cd.mdx index 20922d5..449e5ed 100644 --- a/cli/ci-cd.mdx +++ b/cli/ci-cd.mdx @@ -122,7 +122,7 @@ Progress display goes to stderr. stdout stays empty unless you ask for it. | Goal | Flag | stdout | |---|---|---| | Result URL only | `--url-only` | One line, the signed download URL | -| Full result | `--json` | JSON: `id`, `status`, `outputUrl`, `cost`, timing | +| Full result | `--json` | JSON: `id`, `status`, `output`, `cost`, timing | | Exit code only | `--quiet` | (nothing) | | Submit and exit | `--no-wait` | One line, the job ID | diff --git a/concepts/job-lifecycle.mdx b/concepts/job-lifecycle.mdx index e550d98..2bb99f8 100644 --- a/concepts/job-lifecycle.mdx +++ b/concepts/job-lifecycle.mdx @@ -62,6 +62,21 @@ waiting → dispatched → running → complete Full catalogue: [Error codes](/support/errors). +## Output + +A `complete` job carries one `output` shape, the same for every job type: + +```json +{ + "data": | null, + "file": | null, + "files": [], + "expiresAt": | null +} +``` + +Read `output.data` for a computed answer, `output.file.url` for the file to play or download, and `output.files` for the full list. The shape, the `File` type, the invariants, and the per-type `data` shapes live in one place: [Job output](/concepts/job-output). + ## Timeouts Each job type has a max execution time. Exceeding it auto-fails with `PROVIDER_TIMEOUT`; credits are refunded. A background job runs every 2 minutes to detect stuck jobs that were dispatched or running but never reported back. diff --git a/concepts/job-output.mdx b/concepts/job-output.mdx new file mode 100644 index 0000000..5d32fa6 --- /dev/null +++ b/concepts/job-output.mdx @@ -0,0 +1,290 @@ +--- +title: "Job output shape" +description: "Read the output shape every Rendobar job returns: data, file, files, and expiresAt, the File type, and the four output patterns with examples." +sidebarTitle: "Job output" +icon: "box-open" +keywords: ["job output", "output shape", "output.data", "output.file", "output.files", "file type enum", "rendobar response"] +--- + +