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

# Customer DB: Get Customer Db File

> Read a saved text file, such as a lead scoring model, from your workspace's file store by its path. Includes SDK V2 examples, schemas, and cost.

Read a saved text file, such as a lead scoring model, from your workspace's file store by its path.

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

## 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(
  'get_customer_db_file',
  {
    "path": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute get_customer_db_file --input '{
  "path": "example"
}' --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"]}}
{
  "configured": true,
  "path": "example",
  "content": "Example message",
  "contentHash": "example",
  "version": 1,
  "updatedAt": "2026-01-15T12:00:00Z"
}
```

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

## Input reference

Read a text file from the authenticated workspace customer DB file store.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.path` | `string` | Yes | — | Workspace file path, for example lead\_scoring/model.json. Paths are scoped to the authenticated workspace. Minimum length: 1. |
| `payload.version` | `integer` | No | — | Optional historical version to read. Omit to read the latest version for the path. Minimum: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Read a text file from the authenticated workspace customer DB file store.",
    "properties": {
      "path": {
        "type": "string",
        "description": "Workspace file path, for example lead_scoring/model.json. Paths are scoped to the authenticated workspace.",
        "minLength": 1
      },
      "version": {
        "type": "integer",
        "description": "Optional historical version to read. Omit to read the latest version for the path.",
        "minimum": 1
      }
    },
    "required": [
      "path"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.configured` | `boolean` | Yes | — | — |
| `result.path` | `string` | Yes | — | — |
| `result.content` | `string` | Yes | — | — |
| `result.contentHash` | `string` | Yes | — | — |
| `result.version` | `integer` | Yes | — | — |
| `result.updatedAt` | `string` | Yes | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "configured": {
        "type": "boolean"
      },
      "path": {
        "type": "string"
      },
      "content": {
        "type": [
          "string",
          "null"
        ]
      },
      "contentHash": {
        "type": [
          "string",
          "null"
        ]
      },
      "version": {
        "type": [
          "integer",
          "null"
        ]
      },
      "updatedAt": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "required": [
      "configured",
      "path",
      "content",
      "contentHash",
      "version",
      "updatedAt"
    ],
    "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

* [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.