Run an automation
BetaWe just launched Apps: hosted models, actions and pages, on the same bill as your inference.Read the Apps docs

Run an automation

POSThttps://api.inferencebureau.com/v1/auditor/automations/:id/run

Starts an automation now, as Run now does in the console: one run on every repository in its scope, or on one. Answers 202 once the runs are queued; they start within a minute.

Path

  • idstringrequired

    The automation's id, from List automations. It runs whether or not it is switched on.

Body

application/json, optional
  • repositorystringoptional

    Run on this repository only, as owner/name. It must be in the automation's scope. Left out: every repository in scope.

  • dry_runbooleanoptional

    True: the run does its work and reports what it would have done, and writes nothing to GitHub. Model usage is still charged.

Response

  • firingstringrequired

    This firing's id. Read its runs as they finish with GET /auditor/automations/:id/runs?firing=….

  • queued, skippedintegerrequired

    Runs started, and runs not started.

  • runsarrayrequired

    One per repository. skipped says why a run did not start: the automation's last run there is still going, its hour is full, or its monthly budget is spent.

Notes

  • Keyoptional

    Needs a key with Auditor Permissions: a run spends the team's balance and may write to GitHub. The run records the key as who asked.

  • Errorsoptional

    404 not_found for an id or repository that is not the team's; 400 invalid_request when no repository is in scope.