Skip to main content
Ploid logo
  • Category: ai agents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 42
  • Triggers: 0
  • Slug: PLOID
  • Version: 00000000_00

Tools

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

Input Parameters

string
required
Deep-person research run ID returned by Get Person.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_cancel_setDESTRUCTIVE: 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

string
required
People Set ID whose active search will be irreversibly cancelled. Use only a disposable Set when testing.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_compile_monitorPreview 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_create_datasetCreate 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

string ("sync" | "async")
Sync returns rows inline; async returns a durable background dataset handle.
array
required
Seed rows to fill; sync accepts at most 25 and async accepts at most 2,000.
object
required
Subject type shared by all seed rows.
array
required
One to 30 unique built-in or custom columns to fill.
object
Optional maximum age for cached evidence; omit for field-specific windows.
integer
Sync deadline in milliseconds; unfinished cells become free timeout cells. Ignored for async.
string
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.
boolean
Return best unverified values and evidence; they remain unverified and free.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_create_monitorCreate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_create_setCreate 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

object
Optional total spending controls for Set searches.
Verified background people search started for the new persistent Set.
array
Preview compatibility field that must be omitted or empty for API-key calls; enrich admitted people with separate enrichment actions.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_delete_monitorDestructively 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

string
required
Monitor ID returned by Create Monitor or List Monitors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_enrich_person_contactResolve 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

string
Full name used with company_domain as the person’s identity.
string
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.
array
required
One to three unique contact fields to resolve: work_email, personal_email, and/or phone.
string
Person’s last name, accepted only as an additional clue for email identity.
string
Permanent Ploid person ID used as the person’s identity.
string
Person’s first name, accepted only as an additional clue for email identity.
string
Canonical LinkedIn profile URL used as the person’s identity.
string
Company web domain used with name to identify the person.
string
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.
string
Canonical contact enrichment always returns standard JSON.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_enrich_social_profileResolve 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

string ("linkedin" | "x" | "twitter" | "instagram" | "tiktok" | "youtube" | "github" | "reddit" | "facebook")
required
Social platform to enrich. Use x for new integrations; twitter is a compatibility alias and responses identify that platform as x.
string
required
Handle, vanity slug, or full profile URL for the selected platform. A URL’s domain must match platform.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_export_setExport 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

string ("csv" | "json")
Export representation. csv (the default) returns a downloadable file; json returns admitted items with their raw JSON values.
string
required
People Set ID returned by Create People Set or asynchronous Search People.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_account_creditsReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_account_profileReturn the signed-in user’s WorkOS-linked Ploid account profile. This is a read-only operation, and no charge is documented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_account_usagePreferred 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_datasetReturn a dataset’s lifecycle status, configured columns, row-processing progress, and rows URL. No read charge is documented.

Input Parameters

string
required
Dataset ID returned by Create Dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_linkedin_companyFetch 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

string
Public LinkedIn company URL, vanity slug, or handle.
string
Company search term used when no URL or universal name is supplied.
string
LinkedIn company universal name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_linkedin_profileFetch 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

string
LinkedIn profile locator as a full public profile URL, vanity slug, or @handle. Provide this or identifier, but not both.
string
Provider alias for url; accepts a full LinkedIn profile URL, vanity slug, or @handle. Provide this or url, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_monitorReturn one monitor and its current configuration. No read charge is documented. Ploid requires a monitor permission but does not document its name.

Input Parameters

string
required
Monitor ID returned by Create Monitor or List Monitors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_monitor_runReturn 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

string
required
Monitor run ID returned by Run Monitor or List Monitor Runs.
string
required
Monitor ID returned by Create Monitor or List Monitors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_personGet 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

string
required
Exactly one person identifier: person_id, linkedin_url, or name together with company_domain.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_person_runGet 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

string
required
Deep-person research run ID returned by Get Person.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_get_setReturn 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

string
required
People Set ID returned by Create People Set or asynchronous Search People.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_company_recruitersReturn 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

array
required
One to ten company rows. Each row requires a company name and may include employee-count or ZIP-code hints.
integer
Maximum recruiter matches to return across all input companies (1-150).
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_dataset_rowsReturn one integer-cursor page of dataset rows in seed order, including rows available before asynchronous processing finishes. No read charge is documented.

Input Parameters

integer
Maximum number of dataset rows to return in this page, from 1 to 500.
integer
Non-negative continuation cursor returned as data.next_cursor by the previous page; omit for the first page.
string
required
Dataset ID returned by Create Dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_linkedin_company_postsReturn 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

string
Provider page selector returned or chosen for the next page.
string
LinkedIn company URL, name, handle, or provider identifier.
string
Provider LinkedIn company ID.
string
Opaque provider selector with unpublished semantics. Pass only a value documented by Ploid or previously known to work.
string
Opaque provider token from the preceding response, when present.
string
Opaque provider selector with unpublished semantics. Pass only a value documented by Ploid or previously known to work.
string
LinkedIn company universal name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_linkedin_postsReturn 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

string
LinkedIn profile URL supplied as an alias for identifier.
integer
Maximum number of recent posts to return, from 1 to 20.
string
LinkedIn profile URL, vanity slug, or @handle.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_linkedin_profile_commentsReturn 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

string
Provider page selector returned or chosen for the next page.
string
LinkedIn profile URL, slug, handle, or provider profile ID.
string
Provider LinkedIn profile ID.
string
Opaque provider selector with unpublished semantics. Pass only a value documented by Ploid or previously known to work.
string
Opaque provider token from the preceding response, when present.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_monitor_itemsReturn 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

integer
Maximum number of emitted items to return in this page, from 1 to 100.
string
Continuation cursor returned by the previous page; omit for the first page.
string
required
Monitor ID returned by Create Monitor or List Monitors.
string
Return only items emitted by this monitor run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_monitor_runsReturn 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

integer
Maximum number of monitor runs to return in this page, from 1 to 100.
string
Continuation cursor returned by the previous page; omit for the first page.
string
required
Monitor ID returned by Create Monitor or List Monitors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_monitorsReturn 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

integer
Maximum number of monitors to return in this page, from 1 to 100.
string
Continuation cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_set_itemsReturn 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_list_setsList 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_resolve_personResolve 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

string
required
Full name; a partial or misspelled surname is tolerated.
string
Job title or role that helps identify the person.
string
Phone number with 7 to 15 digits, in any common format.
string
Street or mailing address; it only has to fit the person’s area.
string
Company name or web domain, such as Acme or acme.com.
string
City, region, or country that helps identify the person.
string
Work email. Its domain identifies the employer unless it is a free mailbox provider.
string
Personal email used as an identity clue.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_run_monitorQueue 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

string
required
Monitor ID returned by Create Monitor or List Monitors.
string
Unique key for this exact run request. Reuse it for an identical retry to avoid queueing and billing a duplicate run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_search_github_accountsSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_search_github_peopleSearch 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

string
Repository worked on, in owner/name form.
string ("relevance" | "commits" | "merged_pull_requests" | "recent_activity" | "last_active")
Ordering applied to matching GitHub accounts.
string ("User" | "Organization" | "Bot" | "Mannequin")
GitHub account type to match.
integer
Maximum GitHub accounts to scan on this page.
string
Exact GitHub login, matched case-insensitively.
string
Free text over GitHub login, company, and repository names.
integer
Zero-based GitHub result offset; pass next_offset from the previous page.
string
Company on the GitHub profile; known aliases also match.
boolean
Match GitHub’s public hireable flag.
string
One of the account’s ten most-used programming languages.
object
Hard filters that every returned linked LinkedIn profile must satisfy.
boolean
Match whether a public email was ever listed; the address is not returned.
string
Owner of any repository the account worked on.
boolean
Match GitHub site-administrator status.
boolean
Match GitHub Star program status.
integer
Minimum commits pushed from 2011 through October 2025.
string
Earliest public activity date to include.
string
GitHub login prefix to match.
string
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.
boolean
Drop GitHub accounts that cannot be linked to a LinkedIn profile.
integer
Minimum pushes in the 12 months before the index was built.
boolean
Keep likely bot, CI, and release accounts normally excluded from results.
integer
Minimum authored pull requests merged from 2011 through October 2025.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_search_linkedin_peopleReturn 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

integer
Maximum number of LinkedIn people to return on this page, from 1 to 100.
string
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.
object
Structured hard filters applied to every returned LinkedIn person.
string
Unique key for this POST. Reuse it only for an identical retry so Ploid can replay the response without billing the operation twice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_search_peopleSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_search_people_candidatesSearch 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

string
required
Person name to match; every name term must match an indexed candidate.
integer
Maximum number of candidate matches to return, from 1 to 10.
string
Current job title or role used to narrow candidate matches.
string
Company name used to narrow candidate matches.
string
Location used to narrow candidate matches, such as a city, region, or country.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_test_monitorFetch 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

string
required
Monitor ID returned by Create Monitor or List Monitors.
string
Unique key for this exact test request. Reuse it for an identical retry so a completed billed test is replayed rather than repeated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_test_monitor_webhookImmediately 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

string
required
Monitor ID returned by Create Monitor or List Monitors.
string
Unique key for this exact webhook test. Reuse it for an identical retry to avoid sending the external test event twice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_update_account_profileREAL 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

string
required
New profile image URL, or null to clear the current image.
string
required
New last name; the provider permits an empty value.
string
required
New first name for the signed-in user’s real WorkOS-linked profile.
string
required
New GitHub profile URL, or null to clear it.
string
required
New X/Twitter profile URL, or null to clear it.
string
required
New LinkedIn profile URL, or null to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLOID_update_monitorUpdate, 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not