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

# Call automations.test_run

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

## Request

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

'test this automation', 'dry-run it before we switch it on' — dry-run one automation in this workspace, named by its board_id, against the workspace's synthetic test contact: its draft (or, with no draft, the version that runs) walks every step, sends go only to the workspace's designated test address, waits are skipped and CRM writes are withheld. A person or deal the member names is the test to run: the synthetic test contact stands in for them, and the answer's subject says so. The run starts with the trigger data a real start carries for that contact; sample carries only trigger details the member gave (a form's fields, say), as test values. A run uses model and step time. It answers in two calls: without confirmation_id it proposes, names the version and the test address and runs nothing; the same call again with that confirmation_id, on a member's own API key, runs it. Not for switching it on for real contacts — that is `automations.activate`.

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: The id of the automation to test, as `automations.list` answers it — never its name. Omit it to test the automation this conversation is on; for another automation the operator names, read its board_id from `automations.list` and pass that.
  - `sample` object: Sample trigger data, shaped as a real trigger of this automation would carry it — for a form capture, `{ event: { payload: { fields: { form: "application" } } } }`. Pass it only with trigger details the operator gave (a form they named, say), as test values; a plain test passes none. Any person in it is replaced by the synthetic test contact, which stands in for them. A JSON object, at most 16 KB.
  - `confirmation_id` string, uuid: Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.
  - `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
    - `state` union, required
      - 'confirmation_required'
      - 'tested'
    - `confirmation_id` string, uuid
    - `expires_in_seconds` integer
    - `request_summary` string: What will happen, in one sentence, for a person to approve before confirming.
    - `board_id` string
    - `tested` 'draft' | 'active', required
    - `version` integer
    - `inbox` string, required
    - `run_id` string
    - `subject` string
    - `status` 'pending'
    - `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/bd8f793b36b5?raw)