Runs
A run is one end-to-end documentation update cycle.
Every time Pith is triggered - by a webhook, the CI endpoint, or a manual button click - it creates a run. Each run processes the code diff, calls the relevant agents, and produces documentation output.
Run states
| State | Meaning |
|---|---|
| pending | Run created, waiting to be picked up |
| running | Agents are actively generating content |
| success | All agents completed, PR opened |
| failed | An error occurred; details shown in the dashboard |
| queued | Monthly quota exceeded; run will retry when space opens |
Queued runs
When your monthly run limit is reached, new runs are not dropped. They enter a queued state and are retried automatically at the start of the next billing period or if a run slot becomes available earlier (e.g. after plan upgrade).
Viewing output
Open any run in Dashboard - Runs to see the generated Markdown content, which files were updated, a step-by-step progress log, and a direct link to the documentation pull request.
Trigger types
| Trigger | Source |
|---|---|
| pr_approved | GitHub PR approval or GitLab MR approval via webhook |
| pr_merged | PR / MR merged event via webhook |
| ci | Direct call to POST /api/trigger |
| manual | "Run now" button in the dashboard |
Ready to stop writing docs by hand?
Connect your first repository and Pith will handle the rest.