Skip to content

docs: align cancel + failure-billing wording with the API #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
a-essawy merged 2 commits into from
Jul 31, 2026
Merged

docs: align cancel + failure-billing wording with the API #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cbcf87
docs: align cancel + failure-billing wording with the API
a-essawy Jul 28, 2026
94363a8
Merge branch 'main' into docs/cancel-running-alignment
a-essawy Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion concepts/job.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ flowchart LR
running --> failed
waiting --> cancelled
dispatched --> cancelled
running --> cancelled
```

| Status | What it means |
Expand All @@ -75,7 +76,7 @@ flowchart LR
| `failed` | Errored. Read `error.code` and `error.message`. |
| `cancelled` | Stopped before it finished. |

On any terminal status the job is billed for the compute it used, and a [webhook](/guides/webhooks) fires if you configured one. Failures carry an `error.code` from the [error catalogue](/support/errors). A job that runs past its type's time limit fails with `RUNNER_TIMEOUT` and is not charged.
On any terminal status the job is billed for the compute it used, and a [webhook](/guides/webhooks) fires if you configured one. A job that never started settles free. Failures carry an `error.code` from the [error catalogue](/support/errors). A job that runs past its plan's time limit fails with `JOB_TIMEOUT` and is billed for the compute it consumed. A job a runner accepted but never started fails with `RUNNER_TIMEOUT` and is not charged. Cancelling a `running` job stops the upstream execution too.

## The output

Expand Down
2 changes: 1 addition & 1 deletion mcp-server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Call `list_job_types` first. It returns every active job type fresh, so it never
| `list_jobs` | Recent jobs, filterable by `status` and `type`. | `{ jobs[], total }` |
| `probe_media` | Run ffprobe against a media URL as an async job. Poll `get_job` for the normalized summary and full report. | `{ jobId, status }` |
| `get_account` | Credit balance, plan limits, active jobs, and rate limit usage. | `{ balance, plan, limits }` |
| `cancel_job` | Cancel a job still `waiting` or `dispatched`. | `{ id, status: "cancelled" }` |
| `cancel_job` | Cancel a `waiting`, `dispatched` or `running` job. | `{ id, status: "cancelled" }` |
| `upload_media` | Open an upload session. Presigned URLs for shell-capable callers, or a `pageUrl` for the user to upload from their own device. | `{ session, pageUrl, files[] }` |
| `complete_upload` | Finalize an asset after its bytes land in storage. | `{ asset: { id, url, status } }` |
| `get_upload` | Check an upload session's progress. `wait: true` blocks up to 45 seconds. | `{ status, assets[] }` |
Expand Down
Loading