Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.particle.pro/llms.txt

Use this file to discover all available pages before exploring further.

Return a bundled profile for one company: identifiers (slug, ticker, domain, CIK, QID, linked entity), name, and description. The default response is lean — flip include_products and include_competitors when you need the heavier sub-resources. For sponsor/advertising analytics on this company, use advertising/get_company_ad_presence instead.

Inputs

FieldTypeRequiredDefaultDescription
company_slugstringyesCompany identifier — accepts slug (e.g. "nvidia"), domain (e.g. "nvidia.com"), or canonical ID. If you already know the domain you can call this tool directly without first running resolve_company.
include_productsbooleannofalseInclude the three-level product hierarchy (segments → product lines → products).
product_statusstringno"active"Comma-separated lifecycle filter when include_products=true. Allowed values: active, announced, discontinued, rumored.
include_competitorsbooleannofalseInclude the competitor list (paginated to 25 by default).

Output

A markdown document with the company name as an H2, identifier KV lines (**Slug:**, **Ticker:**, **Domain:**, **CIK:**, **QID:** — only those that have values), then a paragraph with the description. With include_products=true, a ### Products section follows containing an indented bullet hierarchy - **Name** (level, status) (segment → product_line → product). With include_competitors=true, a ### Competitors section follows with one bullet per competitor: - Name (handles) — competitive_basis. Sample (company_slug="nvidia", include_products=true, include_competitors=true, truncated):
## Nvidia

**Slug:** nvidia
**Ticker:** NVDA
**Domain:** nvidia.com
**CIK:** 0001045810
**QID:** Q182477
Nvidia is a leading developer of graphics processing units. …

### Products

- **Automotive** (segment, active)
  - **NVIDIA DRIVE** (product_line, active)
    - **DRIVE Hyperion Platform** (product, active)
- **Compute & Networking** (segment, active)
  - **Data Center Accelerators** (product_line, active)
    - **Blackwell GPUs** (product, active)

### Competitors

- Raspberry Pi Holdings plc (uetersen, raspberrypi.com) — NVIDIA competes with Raspberry Pi in edge AI and robotics segments through its Jetson series of embedded AI computing platforms…

Example

Agent calls: companies/get_company {
  "company_slug": "nvidia",
  "include_products": true,
  "product_status": "active,announced",
  "include_competitors": true
}