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

# Icypeas: Read Bulk Files

> List bulk search files and check whether a batch is in progress or done. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List bulk search files and check whether a batch is in progress or done.

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

## 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(
  'icypeas_read_bulk_files',
  {
    "limit": 123,
    "file": "example",
    "status": "in_progress"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute icypeas_read_bulk_files --input '{
  "limit": 123,
  "file": "example",
  "status": "in_progress"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe icypeas_read_bulk_files --json` for the complete live contract.

## Input reference

List and read bulk search file results. Free endpoint.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.limit` | `integer` | No | — | Number of files to return (1-50). |
| `payload.file` | `string` | No | — | Specific bulk file ID. |
| `payload.status` | `"in_progress" \| "done"` | No | — | Filter by file processing status. Allowed: `in_progress`, `done`. |
| `payload.next` | `boolean` | No | — | Pagination cursor flag. |
| `payload.sort` | `array` | No | — | Sort configuration. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "List and read bulk search file results. Free endpoint.",
    "properties": {
      "limit": {
        "type": "integer",
        "description": "Number of files to return (1-50)."
      },
      "file": {
        "type": "string",
        "description": "Specific bulk file ID."
      },
      "status": {
        "type": "string",
        "description": "Filter by file processing status.",
        "enum": [
          "in_progress",
          "done"
        ]
      },
      "next": {
        "type": "boolean",
        "description": "Pagination cursor flag."
      },
      "sort": {
        "type": "array",
        "description": "Sort configuration.",
        "items": {}
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

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

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "additionalProperties": {}
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "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

* [Icypeas provider guide](https://deepline.com/docs/providers/icypeas/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.