# Extract File — Unstructured

> Extract data from a file. See the documentation

- Key: `unstructured-extract-file`
- Type: Action (Read-only)
- Version: 0.0.1
- App: Unstructured (`unstructured`) — https://pipedream.com/apps/unstructured.md
- This page (HTML): https://pipedream.com/apps/unstructured/actions/extract-file
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/unstructured/actions/extract-file/extract-file.mjs

## Description

Extract data from a file. [See the documentation](https://docs.unstructured.io/api-reference/general/summary)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `file` | `string` | Yes | The file to extract data from. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf) |
| `coordinates` | `boolean` | No | If true, return coordinates for each element extracted via OCR |
| `encoding` | `string` | No | The encoding method used to decode the text input. Default: utf-8 |
| `includePageBreaks` | `boolean` | No | If true, the output will include page breaks if the filetype supports it |
| `strategy` | `string` | No | The strategy to use for partitioning PDF/image |
| `outputFormat` | `string` | No | The format of the response |
| `startingPageNumber` | `integer` | No | When PDF is split into pages before sending it into the API, providing this information will allow the page number to be assigned correctly |
| `vlmModelProvider` | `string` | No | The VLM Model provider to use |
| `vlmModel` | `string` | No | The VLM Model to use. Example: gpt-4o |
| `syncDir` | `dir` | No | SyncDir |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "unstructured",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "unstructured-extract-file",
  arguments: {
    file: "File Path or URL",
    coordinates: true,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "unstructured-extract-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    unstructured: { authProvisionId: "apn_xxxxxxx" },
    file: "File Path or URL",
    coordinates: true,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "unstructured-extract-file",
    "configured_props": {
      "unstructured": { "authProvisionId": "apn_xxxxxxx" },
      "file": "File Path or URL",
      "coordinates": true
    }
  }'
```

---

- App: https://pipedream.com/apps/unstructured.md · All apps: https://pipedream.com/apps