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

# The Swarm: Theswarm Aggregate Profiles

> Aggregate profile field values. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Aggregate profile field values.

<Info>
  Tool ID: `theswarm_aggregate_profiles`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'theswarm_aggregate_profiles',
  {
    "query": "software companies hiring engineers",
    "field": "location"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute theswarm_aggregate_profiles --input '{
  "query": "software companies hiring engineers",
  "field": "location"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "field": "email",
    "values": [
      "example"
    ]
  }
}
```

Use `deepline tools get theswarm_aggregate_profiles --json` for the latest machine-readable contract.

## Input reference

Return distinct values for a single profile field matching a text query (e.g. autocomplete for locations or current job titles).

| Name            | Type                              | Required | Default | Details                                                    |
| --------------- | --------------------------------- | -------- | ------- | ---------------------------------------------------------- |
| `payload.query` | `string`                          | Yes      | —       | Text to match (minimum 3 characters) Minimum length: 3.    |
| `payload.field` | `"location" \| "currentJobTitle"` | Yes      | —       | Field to aggregate Allowed: `location`, `currentJobTitle`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Return distinct values for a single profile field matching a text query (e.g. autocomplete for locations or current job titles).",
    "properties": {
      "query": {
        "type": "string",
        "description": "Text to match (minimum 3 characters)",
        "minLength": 3
      },
      "field": {
        "type": "string",
        "description": "Field to aggregate",
        "enum": [
          "location",
          "currentJobTitle"
        ]
      }
    },
    "required": [
      "query",
      "field"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                 | Type     | Required | Default | Details                                        |
| -------------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data`        | `object` | Yes      | —       | Provider response payload.                     |
| `result.data.field`  | `string` | Yes      | —       | The aggregated field                           |
| `result.data.values` | `array`  | Yes      | —       | Distinct values for the field                  |
| `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": {
          "field": {
            "type": "string",
            "description": "The aggregated field"
          },
          "values": {
            "type": "array",
            "description": "Distinct values for the field",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "field",
          "values"
        ],
        "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

* [The Swarm provider guide](/docs/providers/theswarm/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)