Particle: Search Entities

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

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.

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

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.

{
  "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`.

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

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation