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

# Forager: Location Autocomplete

> Look up location names and IDs to use as company and people search filters. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Look up location names and IDs to use as company and people search filters.

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

## 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(
  'forager_location_autocomplete',
  {
    "q": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute forager_location_autocomplete --input '{
  "q": "software companies hiring engineers"
}' --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": {
    "results": [
      {
        "id": "id_123",
        "text": "example"
      }
    ],
    "pagination": {
      "more": true
    }
  }
}
```

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

## Input reference

Locations objects lookup.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.q` | `string` | Yes | — | City, State, Country or Continent. |
| `payload.page` | `integer` | No | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Locations objects lookup.",
    "properties": {
      "q": {
        "type": "string",
        "description": "City, State, Country or Continent."
      },
      "page": {
        "type": "integer"
      }
    },
    "required": [
      "q"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.results` | `array` | No | — | — |
| `result.data.results[].id` | `string` | No | — | Object primary key. |
| `result.data.results[].text` | `string` | No | — | Location name (Location place type). |
| `result.data.pagination` | `object` | No | — | — |
| `result.data.pagination.more` | `boolean` | No | — | If True then the next page is available. |
| `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": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Object primary key."
                },
                "text": {
                  "type": "string",
                  "description": "Location name (Location place type)."
                }
              },
              "additionalProperties": false
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "more": {
                "type": "boolean",
                "description": "If True then the next page is available."
              }
            },
            "additionalProperties": false
          }
        },
        "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` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

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