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

# Particle: Search Entities

> Search people, companies and other entities by name to resolve a Particle entity slug. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Search people, companies and other entities by name to resolve a Particle entity slug.

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

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute particle_search_entities --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": {
    "data": [
      {
        "match_quality": "exact",
        "mentions": {
          "news_articles": 123,
          "podcast_episodes": 123
        },
        "type": "person"
      }
    ],
    "has_more": true
  }
}
```

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

## Input reference

Find a person, company, or knowledge graph entity by free-text query — a name, partial name, nickname, stock ticker, @handle, or website domain. Returns the best matches ranked by relevance, each tagged with a `match_quality` so you can tell an exact identification from a fuzzy guess. Use it to turn what a user typed into a specific entity — for example before creating an alert to watch it for podcast mentions. Unlike a knowledge graph entity, a result's top-level `type` may be `person`, `company`, or `knowledge_graph_entity`. pass its `id` or `slug` to the matching resource endpoint (/v1/people, /v1/companies, /v1/entities), or its `id` to alert creation.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.limit` | `integer` | No | `25` | Results per page Format: `int64`. Minimum: 1. Maximum: 100. |
| `payload.cursor` | `string` | No | — | Opaque pagination cursor from previous response |
| `payload.q` | `string` | Yes | — | Free-text query: a name, partial name, nickname, stock ticker, @handle, or website domain (e.g. 'sam altman', 'coca cola', 'AAPL', '@sama', 'apple.com'). Minimum length: 1. |
| `payload.type` | `"person" \| "company" \| "knowledge_graph_entity"` | No | — | Restrict results to one kind. Omit to search people, companies, and knowledge graph entities together. Allowed: `person`, `company`, `knowledge_graph_entity`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Find a person, company, or knowledge graph entity by free-text query — a name, partial name, nickname, stock ticker, @handle, or website domain. Returns the best matches ranked by relevance, each tagged with a `match_quality` so you can tell an exact identification from a fuzzy guess. Use it to turn what a user typed into a specific entity — for example before creating an alert to watch it for podcast mentions. Unlike a knowledge graph entity, a result's top-level `type` may be `person`, `company`, or `knowledge_graph_entity`; pass its `id` or `slug` to the matching resource endpoint (/v1/people, /v1/companies, /v1/entities), or its `id` to alert creation.",
    "properties": {
      "limit": {
        "type": "integer",
        "description": "Results per page",
        "default": 25,
        "minimum": 1,
        "maximum": 100,
        "format": "int64"
      },
      "cursor": {
        "type": "string",
        "description": "Opaque pagination cursor from previous response"
      },
      "q": {
        "type": "string",
        "description": "Free-text query: a name, partial name, nickname, stock ticker, @handle, or website domain (e.g. 'sam altman', 'coca cola', 'AAPL', '@sama', 'apple.com').",
        "minLength": 1
      },
      "type": {
        "type": "string",
        "description": "Restrict results to one kind. Omit to search people, companies, and knowledge graph entities together.",
        "enum": [
          "person",
          "company",
          "knowledge_graph_entity"
        ]
      }
    },
    "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.cursor` | `string` | No | — | Pass to next request for more results |
| `result.data.data` | `array` | Yes | — | List of results |
| `result.data.data[].company` | `object` | No | — | — |
| `result.data.data[].company.description` | `string` | No | — | Short company description, when known. |
| `result.data.data[].company.domain` | `string` | No | — | Primary website domain (e.g. 'nvidia.com'), when known. |
| `result.data.data[].company.id` | `string` | Yes | — | Company identifier (domain, slug, or encoded ID) |
| `result.data.data[].company.image_url` | `string` | No | — | Company logo or image URL |
| `result.data.data[].company.name` | `string` | Yes | — | Company name |
| `result.data.data[].company.slug` | `string` | No | — | Stable human-readable handle (the linked knowledge-graph slug, e.g. 'nvidia'), when known. Companies have no slug of their own. prefer this for display and pass it (or id) to /v1/companies. |
| `result.data.data[].company.ticker` | `string` | No | — | Primary stock ticker symbol, when listed. |
| `result.data.data[].knowledge_graph_entity` | `object` | No | — | — |
| `result.data.data[].knowledge_graph_entity.company` | `object` | No | — | — |
| `result.data.data[].knowledge_graph_entity.company.domain` | `string` | No | — | Company website domain |
| `result.data.data[].knowledge_graph_entity.company.id` | `string` | Yes | — | Company identifier |
| `result.data.data[].knowledge_graph_entity.company.ticker` | `string` | No | — | Primary stock ticker symbol |
| `result.data.data[].knowledge_graph_entity.description` | `string` | No | — | Short description |
| `result.data.data[].knowledge_graph_entity.id` | `string` | Yes | — | Unique identifier |
| `result.data.data[].knowledge_graph_entity.image_url` | `string` | No | — | Entity image URL |
| `result.data.data[].knowledge_graph_entity.name` | `string` | Yes | — | Entity name |
| `result.data.data[].knowledge_graph_entity.person` | `object` | No | — | — |
| `result.data.data[].knowledge_graph_entity.person.company` | `string` | No | — | Current company name |
| `result.data.data[].knowledge_graph_entity.person.id` | `string` | Yes | — | Person identifier |
| `result.data.data[].knowledge_graph_entity.person.image_url` | `string` | No | — | Person headshot URL |
| `result.data.data[].knowledge_graph_entity.person.title` | `string` | No | — | Current role title |
| `result.data.data[].knowledge_graph_entity.slug` | `string` | Yes | — | Human-readable slug identifier |
| `result.data.data[].knowledge_graph_entity.type` | `object` | No | — | — |
| `result.data.data[].knowledge_graph_entity.type.name` | `string` | Yes | — | Human-friendly display label (e.g. 'Company'). |
| `result.data.data[].knowledge_graph_entity.type.slug` | `string` | Yes | — | Stable identifier, safe to pass to the type query parameter (e.g. 'company'). |
| `result.data.data[].knowledge_graph_entity.wikipedia_url` | `string` | No | — | Wikipedia URL |
| `result.data.data[].match_quality` | `"exact" \| "strong" \| "contained" \| "fuzzy" \| "description" \| "speculative"` | Yes | — | How confidently the result matched the query, strongest to weakest: 'exact' (a name, identifier, or known alias equals the query, and a query written as separate words also matches a name written as one — 'open ai' is OpenAI. A name ranks ahead of an alias of similar popularity), 'strong' (every query word is present, or the query is an alias of 3 or fewer characters, or an all-caps code of up to 6 characters, such as 'SAM', that several entities share), 'contained' (the result's whole name See the live schema for the complete constraint. |
| `result.data.data[].mentions` | `object` | Yes | — | — |
| `result.data.data[].mentions.news_articles` | `integer` | Yes | — | News articles covering this entity — a secondary popularity signal. Format: `int64`. |
| `result.data.data[].mentions.podcast_episodes` | `integer` | Yes | — | Distinct podcast episodes mentioning this entity — the primary popularity signal. Format: `int64`. |
| `result.data.data[].person` | `object` | No | — | — |
| `result.data.data[].person.description` | `string` | No | — | Short description (e.g. current role), when known. |
| `result.data.data[].person.id` | `string` | Yes | — | Encoded Person identifier |
| `result.data.data[].person.image_url` | `string` | No | — | Canonical headshot URL when one is known for the Person |
| `result.data.data[].person.name` | `string` | Yes | — | Display name |
| `result.data.data[].person.slug` | `string` | No | — | Stable human-readable handle (e.g. 'satya-nadella'). Recommended canonical identifier on every Particle Pro person surface. |
| `result.data.data[].social_links` | `array \| null` | No | — | Third-party social profiles (people & companies), with follower counts where known — confirms the match. |
| `result.data.data[].social_links[].followers` | `integer` | No | — | Audience size where recorded (followers, or subscribers for video platforms). omitted when unknown. Format: `int64`. |
| `result.data.data[].social_links[].platform` | `string` | Yes | — | Platform slug (e.g. 'twitter', 'instagram', 'youtube'). |
| `result.data.data[].social_links[].url` | `string` | Yes | — | Profile URL. |
| `result.data.data[].type` | `"person" \| "company" \| "knowledge_graph_entity"` | Yes | — | Which kind of result this is, and which embedded field is populated: 'person' → /v1/people, 'company' → /v1/companies, 'knowledge\_graph\_entity' → /v1/entities. Allowed: `person`, `company`, `knowledge_graph_entity`. |
| `result.data.has_more` | `boolean` | Yes | — | Whether more results exist |
| `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": {
          "cursor": {
            "type": "string",
            "description": "Pass to next request for more results"
          },
          "data": {
            "type": "array",
            "description": "List of results",
            "items": {
              "type": "object",
              "properties": {
                "company": {
                  "type": "object",
                  "properties": {
                    "description": {
                      "type": "string",
                      "description": "Short company description, when known."
                    },
                    "domain": {
                      "type": "string",
                      "description": "Primary website domain (e.g. 'nvidia.com'), when known."
                    },
                    "id": {
                      "type": "string",
                      "description": "Company identifier (domain, slug, or encoded ID)"
                    },
                    "image_url": {
                      "type": "string",
                      "description": "Company logo or image URL"
                    },
                    "name": {
                      "type": "string",
                      "description": "Company name"
                    },
                    "slug": {
                      "type": "string",
                      "description": "Stable human-readable handle (the linked knowledge-graph slug, e.g. 'nvidia'), when known. Companies have no slug of their own; prefer this for display and pass it (or id) to /v1/companies."
                    },
                    "ticker": {
                      "type": "string",
                      "description": "Primary stock ticker symbol, when listed."
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "knowledge_graph_entity": {
                  "type": "object",
                  "properties": {
                    "company": {
                      "type": "object",
                      "properties": {
                        "domain": {
                          "type": "string",
                          "description": "Company website domain"
                        },
                        "id": {
                          "type": "string",
                          "description": "Company identifier"
                        },
                        "ticker": {
                          "type": "string",
                          "description": "Primary stock ticker symbol"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "description": {
                      "type": "string",
                      "description": "Short description"
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier"
                    },
                    "image_url": {
                      "type": "string",
                      "description": "Entity image URL"
                    },
                    "name": {
                      "type": "string",
                      "description": "Entity name"
                    },
                    "person": {
                      "type": "object",
                      "properties": {
                        "company": {
                          "type": "string",
                          "description": "Current company name"
                        },
                        "id": {
                          "type": "string",
                          "description": "Person identifier"
                        },
                        "image_url": {
                          "type": "string",
                          "description": "Person headshot URL"
                        },
                        "title": {
                          "type": "string",
                          "description": "Current role title"
                        }
                      },
                      "required": [
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "slug": {
                      "type": "string",
                      "description": "Human-readable slug identifier"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Human-friendly display label (e.g. 'Company')."
                        },
                        "slug": {
                          "type": "string",
                          "description": "Stable identifier, safe to pass to the type query parameter (e.g. 'company')."
                        }
                      },
                      "required": [
                        "slug",
                        "name"
                      ],
                      "additionalProperties": false
                    },
                    "wikipedia_url": {
                      "type": "string",
                      "description": "Wikipedia URL"
                    }
                  },
                  "required": [
                    "id",
                    "slug",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "match_quality": {
                  "type": "string",
                  "description": "How confidently the result matched the query, strongest to weakest: 'exact' (a name, identifier, or known alias equals the query, and a query written as separate words also matches a name written as one — 'open ai' is OpenAI; a name ranks ahead of an alias of similar popularity), 'strong' (every query word is present, or the query is an alias of 3 or fewer characters, or an all-caps code of up to 6 characters, such as 'SAM', that several entities share), 'contained' (the result's whole name appears inside a longer query — the query likely names several things; let the user pick), 'fuzzy' (a typo-tolerant similarity match), 'description' (matched only the description text), 'speculative' (a weak remaining match). Auto-select the top hit when it is the only 'exact' result and has_more is false (or a later page holds no other 'exact' result); when several are 'exact' (name twins such as 'Mercury'), or the top hit is weaker, let the user confirm.",
                  "enum": [
                    "exact",
                    "strong",
                    "contained",
                    "fuzzy",
                    "description",
                    "speculative"
                  ]
                },
                "mentions": {
                  "type": "object",
                  "properties": {
                    "news_articles": {
                      "type": "integer",
                      "description": "News articles covering this entity — a secondary popularity signal.",
                      "format": "int64"
                    },
                    "podcast_episodes": {
                      "type": "integer",
                      "description": "Distinct podcast episodes mentioning this entity — the primary popularity signal.",
                      "format": "int64"
                    }
                  },
                  "required": [
                    "podcast_episodes",
                    "news_articles"
                  ],
                  "additionalProperties": false
                },
                "person": {
                  "type": "object",
                  "properties": {
                    "description": {
                      "type": "string",
                      "description": "Short description (e.g. current role), when known."
                    },
                    "id": {
                      "type": "string",
                      "description": "Encoded Person identifier"
                    },
                    "image_url": {
                      "type": "string",
                      "description": "Canonical headshot URL when one is known for the Person"
                    },
                    "name": {
                      "type": "string",
                      "description": "Display name"
                    },
                    "slug": {
                      "type": "string",
                      "description": "Stable human-readable handle (e.g. 'satya-nadella'). Recommended canonical identifier on every Particle Pro person surface."
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "social_links": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "description": "Third-party social profiles (people & companies), with follower counts where known — confirms the match.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "followers": {
                        "type": "integer",
                        "description": "Audience size where recorded (followers, or subscribers for video platforms); omitted when unknown.",
                        "format": "int64"
                      },
                      "platform": {
                        "type": "string",
                        "description": "Platform slug (e.g. 'twitter', 'instagram', 'youtube')."
                      },
                      "url": {
                        "type": "string",
                        "description": "Profile URL."
                      }
                    },
                    "required": [
                      "platform",
                      "url"
                    ],
                    "additionalProperties": false
                  }
                },
                "type": {
                  "type": "string",
                  "description": "Which kind of result this is, and which embedded field is populated: 'person' → /v1/people, 'company' → /v1/companies, 'knowledge_graph_entity' → /v1/entities.",
                  "enum": [
                    "person",
                    "company",
                    "knowledge_graph_entity"
                  ]
                }
              },
              "required": [
                "type",
                "match_quality",
                "mentions"
              ],
              "additionalProperties": false
            }
          },
          "has_more": {
            "type": "boolean",
            "description": "Whether more results exist"
          }
        },
        "required": [
          "data",
          "has_more"
        ],
        "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

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