> ## 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: Generate Map

> Start a market map of companies similar to one you name by name and website or company ID. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Start a market map of companies similar to one you name by name and website or company ID.

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

## 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_generate_map',
  {
    "name": "Example",
    "website": "https://example.com",
    "id": "id_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute aviato_generate_map --input '{
  "name": "Example",
  "website": "https://example.com",
  "id": "id_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": {
    "mapID": "map_123"
  }
}
```

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

## Input reference

Start generating a market map to find similar companies. You can supply either both name and website, or alternatively, an Aviato company ID.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.name` | `string` | No | — | The name of the company to generate a market map for. |
| `payload.website` | `string` | No | — | The website of the company to generate a market map for. |
| `payload.id` | `string` | No | — | The Aviato ID of the company. Can be used instead of supplying name and website. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Start generating a market map to find similar companies. You can supply either both name and website, or alternatively, an Aviato company ID.",
    "properties": {
      "name": {
        "type": "string",
        "description": "The name of the company to generate a market map for."
      },
      "website": {
        "type": "string",
        "description": "The website of the company to generate a market map for."
      },
      "id": {
        "type": "string",
        "description": "The Aviato ID of the company. Can be used instead of supplying name and website."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.mapID` | `string` | Yes | — | — |
| `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": {
          "mapID": {
            "type": "string"
          }
        },
        "required": [
          "mapID"
        ],
        "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: `2.1` 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.