> ## 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.

# HeyReach: Create Workspace API Key

> Generating a new API or integration key for a HeyReach workspace. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Generating a new API or integration key for a HeyReach workspace.

> [!NOTE]
>
> Tool ID: `heyreach_create_workspace_api_key`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'heyreach_create_workspace_api_key',
  {
    "workspace_id": 123,
    "api_key_type": "PUBLIC"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_create_workspace_api_key --input '{
  "workspace_id": 123,
  "api_key_type": "PUBLIC"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "status": "example",
  "result": {
    "key": "example",
    "previousKeyStatus": "example"
  }
}
```

Use `deepline describe heyreach_create_workspace_api_key --json` for the latest machine-readable contract.

## Input reference

HeyReach create workspace API key input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspace_id` | `integer \| string` | Yes | — | Numeric id as integer or numeric string. |
| `payload.api_key_type` | `"PUBLIC" \| "N8N" \| "MAKE" \| "ZAPIER" \| "MCP"` | Yes | — | Allowed: `PUBLIC`, `N8N`, `MAKE`, `ZAPIER`, `MCP`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach create workspace API key input.",
    "properties": {
      "workspace_id": {
        "description": "Numeric id as integer or numeric string.",
        "anyOf": [
          {
            "type": "integer",
            "minimum": 1
          },
          {
            "type": "string",
            "minLength": 1,
            "pattern": "^\\d+$"
          }
        ]
      },
      "api_key_type": {
        "type": "string",
        "enum": [
          "PUBLIC",
          "N8N",
          "MAKE",
          "ZAPIER",
          "MCP"
        ]
      }
    },
    "required": [
      "workspace_id",
      "api_key_type"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.key` | `string` | Yes | — | — |
| `result.result.previousKeyStatus` | `string` | Yes | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "previousKeyStatus": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "previousKeyStatus"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</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

* [HeyReach provider guide](https://deepline.com/docs/providers/heyreach/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.