---
title: "Start a mail assistant command with reads and confirmation-only proposals"
method: POST
path: "/v1/workspaces/{workspaceId}/ai/command-runs"
---

# Start a mail assistant command with reads and confirmation-only proposals

`POST /v1/workspaces/{workspaceId}/ai/command-runs`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/ai/command-runs`
- Auth: HTTP bearer

## Path parameters

- `workspaceId` string, uuid, required

## Headers

- `Idempotency-Key` string, required
- `X-Banger-Product-Id` string, uuid

## Request body

- object
  - `commandText` string, required

## Response `200`

Read requests, an answer, or actions requiring confirmation

- MailAssistantCommand
  - `runId` string, uuid, required
  - `status` 'requires_tool_results' | 'completed' | 'requires_confirmation', required
  - `assistantMessage` string, required
  - `toolCalls` MailAssistantTool[], required
    - `id` string, uuid, required
    - `toolName` string, required
    - `arguments` object, required
    - `reason` string, required
  - `proposedActions` object[], required
    - `id` string, uuid, required
    - `toolName` string, required
    - `arguments` object, required
    - `reason` string, required
    - `confirmationRequired` true, required

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)
