> ## 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: Inputs, Cost & CLI Example

> Search for companies using the Aviato DSL. See the [DSL documentation](/aviato-dsl/aviato-dsl-v-1) for query syntax and available fields.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=aviato_company_search:{"dsl":{}}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name          | Type     | Required | Default | Description                                                                                                                           |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `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={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `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": {
          "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute aviato_company_search --payload '{
  "dsl": {}
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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