> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Run action

> Run a public or internal Convex action.

`convex.runAction` calls a named Convex action and returns its Convex value.

```ts automations/run-convex-report.automation.ts theme={null}
import { automation, onSchedule } from "automate.ax"
import { convex } from "automate.ax/convex"

export default automation("Run Convex report", () => {
  onSchedule({ schedule: "0 8 * * 1" })
  convex.runAction({
    functionName: "reports:generate",
    arguments: { format: "weekly" },
  })
})
```

## Inputs

| Input                          | Type                                              | Required | Default         | Description                                                                   |
| ------------------------------ | ------------------------------------------------- | -------- | --------------- | ----------------------------------------------------------------------------- |
| `functionName`                 | `string`                                          | Yes      | None            | Exported function path.                                                       |
| `arguments`                    | `Record<string, ConvexValue>`                     | No       | `{}`            | Convex function arguments.                                                    |
| `deployment`                   | `string`                                          | No       | `prod`          | Deployment reference for project OAuth. Omit it for a deployment-key account. |
| Second argument: `{ account }` | `string \| IntegrationAccountReference<"convex">` | No       | Project default | Connected Convex account.                                                     |

Use the HTTP API path for internal actions, without the `internal.` prefix used by generated Convex references. Internal actions require credentials allowed to run them. Convex action failures propagate as automation action failures.

The selected deployment must use a hosted `.convex.cloud` URL. Automate.ax can't reach a local development deployment.