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

# Clay Enterprise: Clay Start Routine Run Batch

> Start an async routine run-batch over an uploaded JSONL file. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Start an async routine run-batch over an uploaded JSONL file.

<Info>
  Tool ID: `clay_start_routine_run_batch`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clay_start_routine_run_batch',
  {
    "routine_id": "routine_123",
    "file_id": "file_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute clay_start_routine_run_batch --input '{
  "routine_id": "routine_123",
  "file_id": "file_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "routine_run_id": "routine_run_123",
    "status": "in_progress"
  }
}
```

Use `deepline tools get clay_start_routine_run_batch --json` for the latest machine-readable contract.

## Input reference

Starts an asynchronous batch routine run over a previously uploaded JSONL file.

| Name                 | Type     | Required | Default | Details                                                                                                 |
| -------------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `payload.routine_id` | `string` | Yes      | —       | Minimum length: 1. Maximum length: 64.                                                                  |
| `payload.file_id`    | `string` | Yes      | —       | —                                                                                                       |
| `payload.webhook_id` | `string` | No       | —       | ID of a registered Clay webhook to notify when the run finishes. Minimum length: 1. Maximum length: 64. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Starts an asynchronous batch routine run over a previously uploaded JSONL file.",
    "properties": {
      "routine_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "file_id": {
        "type": "string"
      },
      "webhook_id": {
        "type": "string",
        "description": "ID of a registered Clay webhook to notify when the run finishes.",
        "minLength": 1,
        "maxLength": 64
      }
    },
    "required": [
      "routine_id",
      "file_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                         | Type            | Required | Default | Details                                        |
| ---------------------------- | --------------- | -------- | ------- | ---------------------------------------------- |
| `result.data`                | `object`        | Yes      | —       | Provider response payload.                     |
| `result.data.routine_run_id` | `string`        | Yes      | —       | —                                              |
| `result.data.status`         | `"in_progress"` | Yes      | —       | —                                              |
| `result.meta`                | `object`        | No       | —       | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "routine_run_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "const": "in_progress"
          }
        },
        "required": [
          "routine_run_id",
          "status"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Clay Enterprise provider guide](/docs/providers/clay/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)