---
title: "Call automations.run"
method: POST
path: "/api/v1/tools/automations.run"
tags: ["automations"]
---

# Call automations.run

`POST /api/v1/tools/automations.run`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/automations.run`
- Auth: HTTP bearer

'run the welcome automation now', 'kick off the onboarding automation for this lead' — start a live run of one switched-on automation in this workspace, named by its board_id (automations.list gives each one): the same run its board's Run now starts, on the version that is live, so its sends and actions are real. It answers at once with the run id and pending; the run continues in the background and the automation's board shows how it went. Pass input to give the run its opening values, and a request_id of your own so a retried call answers the first run instead of starting a second. A draft or a switched-off automation is refused and nothing runs. Each run uses model and step time and is billed as a run. Not for trying a draft safely against the workspace's test contact — that is `automations.test_run`.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `board_id` string, uuid, required: The automation's board id, as `automations.list` returns it in board_id.
  - `input` object: Optional values the run starts with, as one JSON object of at most 16 KB; its steps read them from the run's state. The run's own identity (tenant, workspace, user, run id) is set by the platform and cannot be supplied here.
  - `request_id` string, uuid: Optional UUID you choose for this start. Sending the same request_id again answers the first call's run and starts nothing new, so a retried call never runs the automation twice. Omit it and every call starts its own run.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `run_id` string, uuid, required: The run that was started; the automation's board shows it in its run history.
    - `board_id` string, uuid, required
    - `status` 'pending', required: Always pending: the run was handed to the runner and has not run yet.
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/6d82fb124064?raw)