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

# Aviato: Company Search

> Search companies by name, industry, location, headcount, funding and other fields with a structured filter query. Includes SDK V2 examples, schemas, and cost.

Search companies by name, industry, location, headcount, funding and other fields with a structured filter query.

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

## 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(
  'aviato_company_search',
  {
    "dsl": {
      "offset": 123,
      "limit": 123
    }
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute aviato_company_search --input '{
  "dsl": {
    "offset": 123,
    "limit": 123
  }
}' --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"]}}
{
  "data": {
    "count": {
      "value": "example",
      "isEstimate": true
    },
    "items": [
      {
        "id": "id_123"
      }
    ]
  }
}
```

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

## Input reference

Search for companies using the Aviato DSL. The top-level `dsl` object requires integer `offset` and `limit`. Filters must use Aviato DSL filter objects such as `{ "name": { "operation": "textcontains", "value": "Polychain" } }`, not `{ "field": "name", "operation": "contains", "value": "Polychain" }`.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.dsl` | `object` | Yes | — | Aviato DSL query. `offset` and `limit` are required. Use `nameQuery` for text search or `filters` for structured column-path filters. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search for companies using the Aviato DSL. The top-level `dsl` object requires integer `offset` and `limit`. Filters must use Aviato DSL filter objects such as `{ \"name\": { \"operation\": \"textcontains\", \"value\": \"Polychain\" } }`, not `{ \"field\": \"name\", \"operation\": \"contains\", \"value\": \"Polychain\" }`.",
    "properties": {
      "dsl": {
        "type": "object",
        "description": "Aviato DSL query. `offset` and `limit` are required. Use `nameQuery` for text search or `filters` for structured column-path filters.",
        "properties": {
          "offset": {
            "type": "integer",
            "description": "Required integer offset. Aviato accepts values from 0 through 10000.",
            "minimum": 0,
            "maximum": 10000
          },
          "limit": {
            "type": "integer",
            "description": "Required integer page size. Aviato accepts values from 1 through 250.",
            "minimum": 1,
            "maximum": 250
          },
          "nameQuery": {
            "type": "string",
            "description": "Optional full-text search over the name/fullName column."
          },
          "sort": {
            "type": "array",
            "description": "Optional Aviato DSL sort objects. Each object should have one column-path key.",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "filters": {
            "type": "array",
            "description": "Optional Aviato DSL filters. Each filter has exactly one key: `AND`, `OR`, or a column path whose value is an evaluation object with `operation` and `value`.",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          }
        },
        "required": [
          "offset",
          "limit"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "dsl"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.count` | `object` | Yes | — | — |
| `result.data.count.value` | `string` | Yes | — | — |
| `result.data.count.isEstimate` | `boolean` | Yes | — | — |
| `result.data.items` | `array` | Yes | — | — |
| `result.data.items[].id` | `string` | Yes | — | The Aviato ID of the company |
| `result.data.items[].name` | `string` | No | — | The name of the company |
| `result.data.items[].description` | `string` | No | — | Description of the company |
| `result.data.items[].country` | `string` | No | — | The country of the company (Full country name) |
| `result.data.items[].region` | `string` | No | — | The region of the company (state/province) |
| `result.data.items[].locality` | `string` | No | — | The locality of the company (city/town/village) |
| `result.data.items[].URLs` | `object` | No | — | This object represents different urls that can be associated with any type of entity. (Does not include http prefix) |
| `result.data.items[].URLs.golden` | `string` | No | — | — |
| `result.data.items[].URLs.contact` | `string` | No | — | — |
| `result.data.items[].URLs.twitter` | `string` | No | — | — |
| `result.data.items[].URLs.website` | `string` | No | — | — |
| `result.data.items[].URLs.facebook` | `string` | No | — | — |
| `result.data.items[].URLs.github` | `string` | No | — | — |
| `result.data.items[].URLs.linkedin` | `string` | No | — | — |
| `result.data.items[].URLs.pitchbook` | `string` | No | — | — |
| `result.data.items[].URLs.angelList` | `string` | No | — | — |
| `result.data.items[].URLs.signalNFX` | `string` | No | — | — |
| `result.data.items[].URLs.crunchbase` | `string` | No | — | — |
| `result.data.items[].industryList` | `array` | No | — | The industries the company is associated with. |
| `result.meta` | `object` | 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.",
        "properties": {
          "count": {
            "type": "object",
            "properties": {
              "value": {
                "type": "string"
              },
              "isEstimate": {
                "type": "boolean"
              }
            },
            "required": [
              "value",
              "isEstimate"
            ],
            "additionalProperties": false
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "This object represents a company. It includes only the most essential information to identify a company.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The Aviato ID of the company"
                },
                "name": {
                  "type": "string",
                  "description": "The name of the company"
                },
                "description": {
                  "type": "string",
                  "description": "Description of the company"
                },
                "country": {
                  "type": "string",
                  "description": "The country of the company (Full country name)"
                },
                "region": {
                  "type": "string",
                  "description": "The region of the company (state/province)"
                },
                "locality": {
                  "type": "string",
                  "description": "The locality of the company (city/town/village)"
                },
                "URLs": {
                  "type": "object",
                  "description": "This object represents different urls that can be associated with any type of entity. (Does not include http prefix)",
                  "properties": {
                    "golden": {
                      "type": "string"
                    },
                    "contact": {
                      "type": "string"
                    },
                    "twitter": {
                      "type": "string"
                    },
                    "website": {
                      "type": "string"
                    },
                    "facebook": {
                      "type": "string"
                    },
                    "github": {
                      "type": "string"
                    },
                    "linkedin": {
                      "type": "string"
                    },
                    "pitchbook": {
                      "type": "string"
                    },
                    "angelList": {
                      "type": "string"
                    },
                    "signalNFX": {
                      "type": "string"
                    },
                    "crunchbase": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "industryList": {
                  "type": "array",
                  "description": "The industries the company is associated with.",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "count",
          "items"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0.04` per pricing unit.

## Related documentation

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