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

# Akta: Generate Company List

> Generating a targeted company list from structured filters or a natural-language query. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Generating a targeted company list from structured filters or a natural-language query.

<Info>
  Tool ID: `akta_generate_company_list`
</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(
  'akta_generate_company_list',
  {
    "query": "software companies hiring engineers",
    "filters": {},
    "sections": [
      "example"
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute akta_generate_company_list --input '{
  "query": "software companies hiring engineers",
  "filters": {},
  "sections": [
    "example"
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "data": [
      {}
    ],
    "count": 123,
    "total_count": 123
  }
}
```

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

## Input reference

Build targeted company lists using structured filters or natural language queries, with optional data enrichment.

| Name                 | Type                                                                                                                 | Required | Default | Details                                                                                                                                                                                                                                                                                                                                                   |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.query`      | `string`                                                                                                             | No       | —       | Natural language search query (e.g. 'SaaS companies in the US with Series A funding'). Cannot be used with filters.                                                                                                                                                                                                                                       |
| `payload.filters`    | `object`                                                                                                             | No       | —       | Structured filter conditions. Use the Filter Builder API to generate valid filters. Cannot be used with query. See filter options at /api-reference/listgen-api.                                                                                                                                                                                          |
| `payload.sections`   | `array`                                                                                                              | No       | —       | Data enrichment sections to include. Values: firmographic, business\_model, company\_assessment, trust\_signal, company\_hierarchy, digital\_presence, financial\_estimate, location, management\_profile, product\_offering, strategic\_signal, customer\_profile, industry, technology, funding\_detail (Enterprise), mna\_and\_investment (Enterprise) |
| `payload.sort_by`    | `"relevance" \| "revenue_estimate" \| "valuation_estimate" \| "employee_range" \| "total_funding" \| "founded_year"` | No       | —       | Field to sort results by. Default: relevance Allowed: `relevance`, `revenue_estimate`, `valuation_estimate`, `employee_range`, `total_funding`, `founded_year`.                                                                                                                                                                                           |
| `payload.sort_order` | `"asc" \| "desc"`                                                                                                    | No       | —       | Sort direction. Default: desc Allowed: `asc`, `desc`.                                                                                                                                                                                                                                                                                                     |
| `payload.limit`      | `integer`                                                                                                            | No       | —       | Maximum companies to return. Default: 50, Max: 500                                                                                                                                                                                                                                                                                                        |
| `payload.offset`     | `integer`                                                                                                            | No       | —       | Number of results to skip for pagination. Default: 0                                                                                                                                                                                                                                                                                                      |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Build targeted company lists using structured filters or natural language queries, with optional data enrichment.",
    "properties": {
      "query": {
        "type": "string",
        "description": "Natural language search query (e.g. 'SaaS companies in the US with Series A funding'). Cannot be used with filters."
      },
      "filters": {
        "type": "object",
        "description": "Structured filter conditions. Use the Filter Builder API to generate valid filters. Cannot be used with query. See filter options at /api-reference/listgen-api.",
        "additionalProperties": true
      },
      "sections": {
        "type": "array",
        "description": "Data enrichment sections to include. Values: firmographic, business_model, company_assessment, trust_signal, company_hierarchy, digital_presence, financial_estimate, location, management_profile, product_offering, strategic_signal, customer_profile, industry, technology, funding_detail (Enterprise), mna_and_investment (Enterprise)",
        "items": {
          "type": "string"
        }
      },
      "sort_by": {
        "type": "string",
        "description": "Field to sort results by. Default: relevance",
        "enum": [
          "relevance",
          "revenue_estimate",
          "valuation_estimate",
          "employee_range",
          "total_funding",
          "founded_year"
        ]
      },
      "sort_order": {
        "type": "string",
        "description": "Sort direction. Default: desc",
        "enum": [
          "asc",
          "desc"
        ]
      },
      "limit": {
        "type": "integer",
        "description": "Maximum companies to return. Default: 50, Max: 500"
      },
      "offset": {
        "type": "integer",
        "description": "Number of results to skip for pagination. Default: 0"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                      | Type      | Required | Default | Details                                        |
| ------------------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `result.data`             | `object`  | Yes      | —       | Provider response payload.                     |
| `result.data.data`        | `array`   | No       | —       | —                                              |
| `result.data.count`       | `integer` | No       | —       | Number of companies returned.                  |
| `result.data.total_count` | `integer` | No       | —       | Total matching companies. Capped at 500.       |
| `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": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Company object with identity fields (uuid, name, website) plus any requested enrichment sections."
            }
          },
          "count": {
            "type": "integer",
            "description": "Number of companies returned."
          },
          "total_count": {
            "type": "integer",
            "description": "Total matching companies. Capped at 500."
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.03` per pricing unit.

## Related documentation

* [Akta provider guide](/docs/providers/akta/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)