---
canonical_url: "https://docs.composio.dev/toolkits/ploid"
markdown_url: "https://docs.composio.dev/toolkits/ploid.md"
product: "platform"
version: null
last_updated: null
---

# Ploid

Ploid provides people research, identity enrichment, public LinkedIn intelligence, and agent-powered research APIs.

- **Category:** ai agents
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 42
- **Triggers:** 0
- **Slug:** `PLOID`
- **Version:** 00000000_00

## Tools

### Cancel Person Run

**Slug:** `PLOID_cancel_person_run`

Irreversibly cancel an active deep-person research run. Cancellation is uncharged and prevents the run from completing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_run_id` | string | Yes | Deep-person research run ID returned by Get Person. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel People Set

**Slug:** `PLOID_cancel_set`

DESTRUCTIVE: irreversibly stop the active search for a preview People Set. People already admitted remain in the Set and are still billed at 1 ACU per 10 admitted people, rounded up when cancellation settles. The preview request and response contracts may change before general availability. Verify the Set ID before calling, supply an Idempotency-Key for safe identical retries, and never live-test this action without a disposable Set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `set_id` | string | Yes | People Set ID whose active search will be irreversibly cancelled. Use only a disposable Set when testing. |
| `idempotency_key` | string | No | Unique key for this exact authenticated cancellation. Reuse it only for an identical retry so the response replays once; use a fresh key when the Set ID changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compile Monitor

**Slug:** `PLOID_compile_monitor`

Preview a social-monitor plan, resolved targets, relevance rules, and output schema without creating a monitor or scheduling runs. A completed compile costs exactly 1 ACU. Ploid requires authentication but does not publicly document the monitor permission scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Natural-language social activity to monitor. Compiling costs exactly 1 ACU and creates no monitor. |
| `output` | object | No | Optional text or structured-object output requested for matching activity. |
| `idempotency_key` | string | No | Unique key for this exact request. Reuse it for an identical retry; use a fresh key when the query or output changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dataset

**Slug:** `PLOID_create_dataset`

Create a persistent typed dataset and fill 1-30 columns for seeded people, companies, or custom entities. Sync supports up to 25 rows; async supports 2,000 and continues processing and billing after this call returns. Ploid reserves the all-found maximum against the API-key budget, then bills only found cells: standard built-ins cost 1 ACU per 10, custom and work-email cells 1 each, personal email 3 each, and phone 10 each. Not-found, unverified, and timeout cells are free. A failed sync fill can still persist and bill completed cells; recover them with the dataset_id in the error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("sync" | "async") | No | Sync returns rows inline; async returns a durable background dataset handle. |
| `rows` | array | Yes | Seed rows to fill; sync accepts at most 25 and async accepts at most 2,000. |
| `entity` | object | Yes | Subject type shared by all seed rows. |
| `columns` | array | Yes | One to 30 unique built-in or custom columns to fill. |
| `freshness` | object | No | Optional maximum age for cached evidence; omit for field-specific windows. |
| `deadline_ms` | integer | No | Sync deadline in milliseconds; unfinished cells become free timeout cells. Ignored for async. |
| `idempotency_key` | string | No | Unique key for this exact authenticated request. Reuse it only for an identical retry within 24 hours so creation and billing replay once; use a fresh key when any input changes. |
| `include_unverified` | boolean | No | Return best unverified values and evidence; they remain unverified and free. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Monitor

**Slug:** `PLOID_create_monitor`

Create a persistent scheduled social monitor and immediately start a silent baseline run. Creation and compilation cost 1 ACU. Each later run costs 1 ACU per target fetched plus 1 ACU per emitted item. Supply an Idempotency-Key and reuse it with identical input when retrying an uncertain result. Webhook configuration is intentionally unavailable in this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional human-readable monitor name. |
| `plan` | object | No | Optional precompiled targets and relevance criteria; omit to let Ploid compile the query. |
| `query` | string | Yes | Natural-language description of the social activity to monitor. |
| `output` | object | No | Text or structured output requested for each emitted monitor item. |
| `schedule` | string | Yes | Hourly, daily, weekly, or five-field cron schedule for future monitor runs. |
| `idempotency_key` | string | No | Unique key for this exact creation request. Reuse it for an identical retry; use a fresh key when any monitor input changes. |
| `max_items_per_run` | integer | No | Maximum items a later monitor run may emit (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create People Set

**Slug:** `PLOID_create_set`

Create a persistent preview People Set and start durable verified background work that may continue after this call returns. The preview request and response contracts may change before general availability. Ploid checks available balance and reserves the requested count's estimated charge against API-key daily and monthly budgets, then settles at 1 ACU per 10 admitted people, rounded up; people admitted before failure or cancellation remain billed. Supply an Idempotency-Key and reuse it only for an identical retry so creation and billing replay once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `budget` | object | No | Optional total spending controls for Set searches. |
| `search` | object | Yes | Verified background people search started for the new persistent Set. |
| `enrichments` | array | No | Preview compatibility field that must be omitted or empty for API-key calls; enrich admitted people with separate enrichment actions. |
| `idempotency_key` | string | No | Unique key for this exact authenticated request. Reuse it only for an identical retry so Set creation and billing replay once; use a fresh key when any input changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Monitor

**Slug:** `PLOID_delete_monitor`

Destructively and irreversibly disable a monitor. It will no longer run on its schedule; verify the monitor ID before calling. No charge is documented. Ploid requires a monitor permission but does not document its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Person Contact

**Slug:** `PLOID_enrich_person_contact`

Resolve requested work email, personal email, and/or phone fields for one person. Identify the person with exactly one of linkedin_url, person_id, email, or name together with company_domain. Only found fields are billed; clean misses and provider failures are free. Per-field prices are not published. Partial responses preserve each field's status and provide retry guidance in warnings and Retry-After.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Full name used with company_domain as the person's identity. |
| `email` | string | No | Email used as the person's identity. With first_name and last_name at a work domain, Ploid searches for that person at the company; otherwise it performs a reverse lookup for the person behind the email. |
| `fields` | array | Yes | One to three unique contact fields to resolve: work_email, personal_email, and/or phone. |
| `last_name` | string | No | Person's last name, accepted only as an additional clue for email identity. |
| `person_id` | string | No | Permanent Ploid person ID used as the person's identity. |
| `first_name` | string | No | Person's first name, accepted only as an additional clue for email identity. |
| `linkedin_url` | string | No | Canonical LinkedIn profile URL used as the person's identity. |
| `company_domain` | string | No | Company web domain used with name to identify the person. |
| `idempotency_key` | string | No | Unique key for this exact request. Reuse it for an identical retry, including a retryable 503, so the response is replayed and billed once. After a partial 200, use a fresh key and request only unavailable fields. |
| `response_format` | string | No | Canonical contact enrichment always returns standard JSON. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Social Profile

**Slug:** `PLOID_enrich_social_profile`

Resolve one public social profile from a supported platform handle, vanity slug, or profile URL. Successful enrichment is billed at a platform-specific amount that is not fully published; profile-not-found and provider failures are free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `platform` | string ("linkedin" | "x" | "twitter" | "instagram" | "tiktok" | "youtube" | "github" | "reddit" | "facebook") | Yes | Social platform to enrich. Use x for new integrations; twitter is a compatibility alias and responses identify that platform as x. |
| `identifier` | string | Yes | Handle, vanity slug, or full profile URL for the selected platform. A URL's domain must match platform. |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse it only to retry an identical authenticated request so the response is replayed and billed once; use a new key when the platform or identifier changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export People Set

**Slug:** `PLOID_export_set`

Export admitted items from a preview People Set. CSV is the default and returns a downloadable file; JSON returns the provider's raw item values. No export charge is documented. The preview Sets API is absent from Ploid's OpenAPI document and its response contract may change before general availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "json") | No | Export representation. csv (the default) returns a downloadable file; json returns admitted items with their raw JSON values. |
| `set_id` | string | Yes | People Set ID returned by Create People Set or asynchronous Search People. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Credits

**Slug:** `PLOID_get_account_credits`

Return the workspace ACU balance and the calling API key's daily and monthly spending-budget state. This read-only request has no documented charge.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Profile

**Slug:** `PLOID_get_account_profile`

Return the signed-in user's WorkOS-linked Ploid account profile. This is a read-only operation, and no charge is documented.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Usage

**Slug:** `PLOID_get_account_usage`

Preferred connection diagnostic for verifying which Ploid workspace and API key are connected. Returns workspace ACU usage, the calling key's ID and budget, and the number of active keys. No charge is documented.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dataset

**Slug:** `PLOID_get_dataset`

Return a dataset's lifecycle status, configured columns, row-processing progress, and rows URL. No read charge is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dataset_id` | string | Yes | Dataset ID returned by Create Dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Company

**Slug:** `PLOID_get_linkedin_company`

Fetch public LinkedIn company details by URL, universal name, or search term; provide at least one of those locators. This read can consume ACU, but Ploid does not publish a fixed amount.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public LinkedIn company URL, vanity slug, or handle. |
| `search` | string | No | Company search term used when no URL or universal name is supplied. |
| `universal_name` | string | No | LinkedIn company universal name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile

**Slug:** `PLOID_get_linkedin_profile`

Fetch one public LinkedIn profile by full URL, vanity slug, or @handle. Warning: this read can consume ACU, but Ploid does not publish a fixed per-call cost; workspace balance and API-key budget checks apply.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | LinkedIn profile locator as a full public profile URL, vanity slug, or @handle. Provide this or identifier, but not both. |
| `identifier` | string | No | Provider alias for url; accepts a full LinkedIn profile URL, vanity slug, or @handle. Provide this or url, but not both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Monitor

**Slug:** `PLOID_get_monitor`

Return one monitor and its current configuration. No read charge is documented. Ploid requires a monitor permission but does not document its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Monitor Run

**Slug:** `PLOID_get_monitor_run`

Return one monitor run by monitor and run ID, including lifecycle state, usage, error, and webhook delivery outcome. No read charge is documented. Ploid requires monitor permission but does not publicly name its scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_id` | string | Yes | Monitor run ID returned by Run Monitor or List Monitor Runs. |
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Person

**Slug:** `PLOID_get_person`

Get an evidence-backed reviewed person record or start a durable research run. The first successful organization-wide profile access costs exactly 25 ACU, including a first access served from cache; rereads are free for 90 days, and failed, unsure, or not-found runs are free. A 202 response is only a run handle: poll it with Get Person Run rather than repeating this POST. Stale cached results can queue a background refresh.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifier` | string | Yes | Exactly one person identifier: person_id, linkedin_url, or name together with company_domain. |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse it only to retry an identical request so the response is replayed and billed once; use a new key when any input changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Person Run

**Slug:** `PLOID_get_person_run`

Get the current state or terminal result of a deep-person research run. Polling has no separate charge; the originating successful profile may cost 25 ACU.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_run_id` | string | Yes | Deep-person research run ID returned by Get Person. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get People Set

**Slug:** `PLOID_get_set`

Return a preview People Set's status, progress, and searches, newest first. No read charge is documented. This preview API is absent from Ploid's OpenAPI document and its response contract may change before general availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `set_id` | string | Yes | People Set ID returned by Create People Set or asynchronous Search People. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Recruiters

**Slug:** `PLOID_list_company_recruiters`

Return recruiters and role counts for up to 10 companies. Ploid bills unique non-placeholder companies for returned matches, but the exact ACU amount is not published.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `companies` | array | Yes | One to ten company rows. Each row requires a company name and may include employee-count or ZIP-code hints. |
| `max_recruiters` | integer | No | Maximum recruiter matches to return across all input companies (1-150). |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse it only to retry an identical request so the response is replayed and billed once; do not reuse it with changed input. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dataset Rows

**Slug:** `PLOID_list_dataset_rows`

Return one integer-cursor page of dataset rows in seed order, including rows available before asynchronous processing finishes. No read charge is documented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of dataset rows to return in this page, from 1 to 500. |
| `cursor` | integer | No | Non-negative continuation cursor returned as data.next_cursor by the previous page; omit for the first page. |
| `dataset_id` | string | Yes | Dataset ID returned by Create Dataset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List LinkedIn Company Posts

**Slug:** `PLOID_list_linkedin_company_posts`

Return one provider page of posts for a LinkedIn company. The fixed cost is unknown. Use company, company_id, or company_universal_name to select a company when needed. Optional posted_limit and scrape_posted_limit opaque provider selectors are available for values documented by Ploid or previously known to work. Supply page and pagination_token manually because the response location of the next token is undocumented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page selector returned or chosen for the next page. |
| `company` | string | No | LinkedIn company URL, name, handle, or provider identifier. |
| `company_id` | string | No | Provider LinkedIn company ID. |
| `posted_limit` | string | No | Opaque provider selector with unpublished semantics. Pass only a value documented by Ploid or previously known to work. |
| `pagination_token` | string | No | Opaque provider token from the preceding response, when present. |
| `scrape_posted_limit` | string | No | Opaque provider selector with unpublished semantics. Pass only a value documented by Ploid or previously known to work. |
| `company_universal_name` | string | No | LinkedIn company universal name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List LinkedIn Posts

**Slug:** `PLOID_list_linkedin_posts`

Return up to 20 recent posts for one public LinkedIn profile identified by profile URL, vanity slug, or @handle; provide identifier or its url alias. This read can consume ACU, but Ploid does not publish a fixed cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | LinkedIn profile URL supplied as an alias for identifier. |
| `limit` | integer | No | Maximum number of recent posts to return, from 1 to 20. |
| `identifier` | string | No | LinkedIn profile URL, vanity slug, or @handle. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List LinkedIn Profile Comments

**Slug:** `PLOID_list_linkedin_profile_comments`

Return one provider page of comments made by a LinkedIn profile. This read can consume ACU, but Ploid does not publish a fixed amount. Use profile or profile_id to select a profile when needed. The optional posted_limit opaque provider selector is available for a value documented by Ploid or previously known to work. Supply page and pagination_token manually because the response location of the next token is undocumented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page selector returned or chosen for the next page. |
| `profile` | string | No | LinkedIn profile URL, slug, handle, or provider profile ID. |
| `profile_id` | string | No | Provider LinkedIn profile ID. |
| `posted_limit` | string | No | Opaque provider selector with unpublished semantics. Pass only a value documented by Ploid or previously known to work. |
| `pagination_token` | string | No | Opaque provider token from the preceding response, when present. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Monitor Items

**Slug:** `PLOID_list_monitor_items`

Return one cursor-controlled page of emitted monitor items, optionally limited to one run. No read charge is documented. Ploid requires a monitor permission but does not document its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of emitted items to return in this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |
| `run_id_filter` | string | No | Return only items emitted by this monitor run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Monitor Runs

**Slug:** `PLOID_list_monitor_runs`

Return one cursor-controlled page of a monitor's runs, newest first. No read charge is documented. Ploid requires a monitor permission but does not document its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of monitor runs to return in this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Monitors

**Slug:** `PLOID_list_monitors`

Return one cursor-controlled page of monitors, newest first. No read charge is documented. Ploid requires monitor permission but does not publicly name the required scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of monitors to return in this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People Set Items

**Slug:** `PLOID_list_set_items`

Return one caller-controlled page of admitted, criterion-verified people while or after a preview People Set runs. Reading does not have a documented charge; billing belongs to the originating search and settles at 1 ACU per 10 admitted people, rounded up. Follow data.next_cursor for the next page; the preview API may add further response metadata before general availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of admitted people to return in this page, from 1 to 200. |
| `cursor` | string | No | Opaque continuation cursor obtained from the previous provider response; omit for the first page. |
| `set_id` | string | Yes | People Set ID returned by Create People Set or an asynchronous people search. |
| `status` | string ("admitted" | "review" | "all") | No | Requested item status. API keys return admitted people even when review or all is selected; omit to use the provider default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People Sets

**Slug:** `PLOID_list_sets`

List the workspace's recent People Sets. This API is in preview: Ploid documents the response as data.sets and does not document item fields or pagination controls. No read charge is documented.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve Person

**Slug:** `PLOID_resolve_person`

Resolve a named person plus at least one identity clue to a permanent Ploid person ID. A found match costs 2 ACU; no match is free. Reusing an idempotency key is safe only for an identical authenticated retry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Full name; a partial or misspelled surname is tolerated. |
| `role` | string | No | Job title or role that helps identify the person. |
| `phone` | string | No | Phone number with 7 to 15 digits, in any common format. |
| `address` | string | No | Street or mailing address; it only has to fit the person's area. |
| `company` | string | No | Company name or web domain, such as Acme or acme.com. |
| `location` | string | No | City, region, or country that helps identify the person. |
| `work_email` | string | No | Work email. Its domain identifies the employer unless it is a free mailbox provider. |
| `personal_email` | string | No | Personal email used as an identity clue. |
| `idempotency_key` | string | No | Unique key for this exact request. Reuse it only when retrying the identical authenticated request so the response is replayed and billed once; use a fresh key if any input changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Monitor

**Slug:** `PLOID_run_monitor`

Queue a persistent monitor run now. It costs 1 ACU per target fetched plus 1 ACU per emitted item, saves emitted items, and may deliver events to the monitor's configured webhook. The run continues after the 202 response. Poll the returned run instead of repeating this POST. Supply an Idempotency-Key and reuse it with identical input for an uncertain retry. The required monitor permission name is undocumented.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |
| `idempotency_key` | string | No | Unique key for this exact run request. Reuse it for an identical retry to avoid queueing and billing a duplicate run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search GitHub Accounts

**Slug:** `PLOID_search_github_accounts`

Search Ploid's GitHub account index by profile, repository, language, and activity filters. Provide at least one account search criterion. Each completed search costs 1 ACU; include_profiles adds 1 ACU per live profile found. Failed searches are free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repo` | string | No | Repository the account worked on, in owner/name form. |
| `sort` | string ("relevance" | "commits" | "merged_pull_requests" | "recent_activity" | "last_active") | No | Ranking: relevance, commits, merged pull requests, recent pushes, or latest activity. |
| `type` | string ("User" | "Organization" | "Bot" | "Mannequin") | No | GitHub account type to match. |
| `limit` | integer | No | Results in this page (1-100, or at most 10 with include_profiles). |
| `login` | string | No | Exact GitHub login to match, case-insensitively. |
| `query` | string | No | Free text matched against GitHub login, company, and repository names. |
| `offset` | integer | No | Results to skip; pass data.next_offset from the prior page. |
| `company` | string | No | Profile company to match; Ploid also matches known company aliases. |
| `hireable` | boolean | No | Match GitHub's public hireable flag. |
| `language` | string | No | Match one of the account's ten most-used repository languages. |
| `has_email` | boolean | No | Match whether a public email was ever listed; the address is not returned. |
| `repo_owner` | string | No | Owner of any repository the account worked on. |
| `site_admin` | boolean | No | Match GitHub site-administrator status. |
| `github_star` | boolean | No | Match GitHub Stars program membership. |
| `min_commits` | integer | No | Minimum commits pushed from 2011 through October 2025. |
| `active_since` | string | No | Match accounts with public activity on or after this date. |
| `login_prefix` | string | No | Prefix of the GitHub login to match. |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse it only for an identical authenticated retry so Ploid replays and bills the request once. |
| `include_profiles` | boolean | No | Attach live public profiles for 1 additional ACU per profile found. |
| `min_recent_pushes` | integer | No | Minimum pushes in the 12 months before Ploid built the index. |
| `include_automation` | boolean | No | Keep likely bot, CI, and release accounts normally excluded from results. |
| `min_merged_pull_requests` | integer | No | Minimum authored pull requests merged from 2011 through October 2025. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search GitHub People

**Slug:** `PLOID_search_github_people`

Search GitHub accounts, link unambiguous accounts to indexed LinkedIn people, and enforce optional LinkedIn filters as hard requirements. Provide at least one GitHub search criterion. Costs 1 ACU per completed search plus 1 ACU per returned person; failed searches are free. Pages advance over GitHub accounts scanned, so returned results can be fewer than the page limit; continue with data.next_offset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repo` | string | No | Repository worked on, in owner/name form. |
| `sort` | string ("relevance" | "commits" | "merged_pull_requests" | "recent_activity" | "last_active") | No | Ordering applied to matching GitHub accounts. |
| `type` | string ("User" | "Organization" | "Bot" | "Mannequin") | No | GitHub account type to match. |
| `limit` | integer | No | Maximum GitHub accounts to scan on this page. |
| `login` | string | No | Exact GitHub login, matched case-insensitively. |
| `query` | string | No | Free text over GitHub login, company, and repository names. |
| `offset` | integer | No | Zero-based GitHub result offset; pass next_offset from the previous page. |
| `company` | string | No | Company on the GitHub profile; known aliases also match. |
| `hireable` | boolean | No | Match GitHub's public hireable flag. |
| `language` | string | No | One of the account's ten most-used programming languages. |
| `linkedin` | object | No | Hard filters that every returned linked LinkedIn profile must satisfy. |
| `has_email` | boolean | No | Match whether a public email was ever listed; the address is not returned. |
| `repo_owner` | string | No | Owner of any repository the account worked on. |
| `site_admin` | boolean | No | Match GitHub site-administrator status. |
| `github_star` | boolean | No | Match GitHub Star program status. |
| `min_commits` | integer | No | Minimum commits pushed from 2011 through October 2025. |
| `active_since` | string | No | Earliest public activity date to include. |
| `login_prefix` | string | No | GitHub login prefix to match. |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse only for an identical authenticated retry so the response is replayed and billed once; use a new key when any input changes. |
| `require_linkedin` | boolean | No | Drop GitHub accounts that cannot be linked to a LinkedIn profile. |
| `min_recent_pushes` | integer | No | Minimum pushes in the 12 months before the index was built. |
| `include_automation` | boolean | No | Keep likely bot, CI, and release accounts normally excluded from results. |
| `min_merged_pull_requests` | integer | No | Minimum authored pull requests merged from 2011 through October 2025. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn People

**Slug:** `PLOID_search_linkedin_people`

Return one cursor-controlled page of public LinkedIn people matching structured keyword, location, title, current-company, and school filters. This search can consume ACU or API-key budget, but Ploid does not publish a fixed cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of LinkedIn people to return on this page, from 1 to 100. |
| `cursor` | string | No | Continuation cursor from data.cursor in a previous response. Omit it for the first page and pass it back unchanged to fetch the next page. |
| `filters` | object | No | Structured hard filters applied to every returned LinkedIn person. |
| `idempotency_key` | string | No | Unique key for this POST. Reuse it only for an identical retry so Ploid can replay the response without billing the operation twice. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search People

**Slug:** `PLOID_search_people`

Search for up to 150 people and return typed results inline. Pricing varies by search mode and returned results. Use Create People Set for durable background searches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("instant" | "fast" | "auto" | "deep") | No | Search mode: instant uses indexed candidates; fast ranks indexed candidates; auto and deep verify with evidence, with deep always grounding on the public web. |
| `query` | string | No | Semantic people query. Provide a non-empty query, at least one filter, or both. |
| `filters` | object | No | Hard filters combined with AND and enforced on every returned result. |
| `contents` | object | No | Fields to include in each people-search result. |
| `criteria` | array | No | Up to five non-empty plain-English conditions independently verified for every result; requires auto or deep search. |
| `freshness` | object | No | Maximum age policy for evidence; requires auto or deep search. |
| `num_results` | integer | No | Maximum number of people to return inline, from 1 to 150. |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse only for an identical authenticated retry so it is billed once. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search People Candidates

**Slug:** `PLOID_search_people_candidates`

Search the indexed people directory for up to 10 unverified identity candidates. Costs exactly 1 ACU for every completed search, including zero matches; failures are free. Does not research or enrich profiles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Person name to match; every name term must match an indexed candidate. |
| `limit` | integer | No | Maximum number of candidate matches to return, from 1 to 10. |
| `title` | string | No | Current job title or role used to narrow candidate matches. |
| `company` | string | No | Company name used to narrow candidate matches. |
| `location` | string | No | Location used to narrow candidate matches, such as a city, region, or country. |
| `idempotency_key` | string | No | Unique key for this exact POST. Reuse it only to retry an identical request so the response is replayed and billed once; use a new key when any input changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Monitor

**Slug:** `PLOID_test_monitor`

Fetch and evaluate a monitor's current targets without saving a run, items, seen-ledger entries, or snapshots; sending a webhook; or changing its schedule. Each call costs exactly 1 ACU per target fetched, including targets that yield no relevant items. Ploid does not document the required monitor permission name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |
| `idempotency_key` | string | No | Unique key for this exact test request. Reuse it for an identical retry so a completed billed test is replayed rather than repeated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Monitor Webhook

**Slug:** `PLOID_test_monitor_webhook`

Immediately send one signed monitor.webhook.test event to the monitor's configured external webhook. This causes external network delivery as soon as the action runs. Ploid makes one delivery attempt with no retries, and this operation costs no ACU. Supply an Idempotency-Key and reuse it with identical input after an uncertain result to avoid duplicate delivery. Ploid requires a monitor permission but does not document its name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |
| `idempotency_key` | string | No | Unique key for this exact webhook test. Reuse it for an identical retry to avoid sending the external test event twice. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Profile

**Slug:** `PLOID_update_account_profile`

REAL ACCOUNT MUTATION: replace the signed-in user's WorkOS-linked Ploid profile fields. Every field is required; null clears a profile URL. No charge is documented. NEVER TEST OR CALL THIS ACTION against a real account; use it only with an explicitly authorized disposable account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_url` | string | Yes | New profile image URL, or null to clear the current image. |
| `last_name` | string | Yes | New last name; the provider permits an empty value. |
| `first_name` | string | Yes | New first name for the signed-in user's real WorkOS-linked profile. |
| `github_url` | string | Yes | New GitHub profile URL, or null to clear it. |
| `twitter_url` | string | Yes | New X/Twitter profile URL, or null to clear it. |
| `linkedin_url` | string | Yes | New LinkedIn profile URL, or null to clear it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Monitor

**Slug:** `PLOID_update_monitor`

Update, pause, or resume a monitor by providing at least one field to change. This mutates its durable configuration; query or plan changes start a new baseline run and may lead to later scheduled work. No fixed update charge is documented, but baseline work can consume ACU or API-key budget. Webhook configuration is intentionally unavailable in this action. Ploid does not document the monitor permission name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New human-readable monitor name. Null is not accepted. |
| `plan` | object | No | Replacement targets and relevance criteria. Changing the plan starts a new baseline run. |
| `query` | string | No | New natural-language monitoring request. Changing it recompiles the plan and starts a new baseline run. |
| `output` | object | No | Replacement text or structured output configuration. |
| `status` | string ("active" | "paused") | No | Set active to resume scheduled runs or paused to suspend them. |
| `schedule` | string | No | Replacement preset or five-field cron schedule. |
| `monitor_id` | string | Yes | Monitor ID returned by Create Monitor or List Monitors. |
| `max_items_per_run` | integer | No | New maximum number of relevant items emitted by each run, from 1 to 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |