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

# CrustData V3: Job Search Autocomplete

> Free typeahead suggestions for exact job search field values. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Free typeahead suggestions for exact job search field values.

> [!NOTE]
>
> Tool ID: `crustdata_v3_job_search_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(
  'crustdata_v3_job_search_autocomplete',
  {
    "field": "email",
    "query": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute crustdata_v3_job_search_autocomplete --input '{
  "field": "email",
  "query": "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": {
    "suggestions": [
      {
        "value": "example"
      }
    ]
  }
}
```

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

## Input reference

Request body for autocompleting the values of a single `/job/search` field.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.field` | `string` | Yes | — | The `/job/search` field whose values to autocomplete. Accepts the same names used in `/job/search` filters, plus their short aliases. Common values: `title`, `category`, `company.name`, `company.industries`, `location.country`, `location.city`, `location.state`. Full set of supported fields: `category`, `city`, `company.basic_info.industries`, `company.basic_info.name`, `company.basic_info.primary_domain`, `company.funding.investors`, `company.funding.last_round_type`, See the live schema for the complete constraint. |
| `payload.query` | `string` | Yes | — | Partial text to match against the field's values. May be an empty string to return top values. |
| `payload.limit` | `integer` | No | `20` | Maximum number of suggestions to return. Must be between 1 and 100. Minimum: 1. Maximum: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request body for autocompleting the values of a single `/job/search` field.",
    "properties": {
      "field": {
        "type": "string",
        "description": "The `/job/search` field whose values to autocomplete. Accepts the same names used in `/job/search` filters, plus their short aliases. Common values: `title`, `category`, `company.name`, `company.industries`, `location.country`, `location.city`, `location.state`. Full set of supported fields: `category`, `city`, `company.basic_info.industries`, `company.basic_info.name`, `company.basic_info.primary_domain`, `company.funding.investors`, `company.funding.last_round_type`, `company.headcount.largest_country`, `company.headcount.range`, `company.industries`, `company.locations.city`, `company.locations.country`, `company.locations.state`, `company.name`, `company.revenue.acquisition_status`, `company.revenue.public_markets.fiscal_year_end`, `company.revenue.public_markets.stock_symbols`, `continent`, `country`, `country_code`, `district`, `fiscal_year_end`, `job_category`, `job_details.category`, `job_details.title`, `job_details.workplace_type`, `job_title`, `location`, `location.city`, `location.country`, `location.district`, `location.raw`, `location.state`, `locations.city`, `locations.country`, `locations.district`, `locations.location`, `locations.state`, `state`, `title`, `workplace_type`."
      },
      "query": {
        "type": "string",
        "description": "Partial text to match against the field's values. May be an empty string to return top values."
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of suggestions to return. Must be between 1 and 100.",
        "default": 20,
        "minimum": 1,
        "maximum": 100
      }
    },
    "required": [
      "field",
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Autocomplete suggestions for the requested field and query. |
| `result.data.suggestions` | `array` | Yes | — | Matching values for the requested field, ordered by relevance. Empty when nothing matches. |
| `result.data.suggestions[].value` | `string` | Yes | — | A suggested value for the requested field. |
| `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": "Autocomplete suggestions for the requested field and query.",
        "properties": {
          "suggestions": {
            "type": "array",
            "description": "Matching values for the requested field, ordered by relevance. Empty when nothing matches.",
            "items": {
              "type": "object",
              "description": "A single autocomplete suggestion.",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "A suggested value for the requested field."
                }
              },
              "required": [
                "value"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "suggestions"
        ],
        "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

* [CrustData V3 provider guide](https://deepline.com/docs/providers/crustdata-v3/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.