Skip to Content

Connect Ploid to Your AI Agent

Find relevant people and turn sourced profiles into structured research.

47 toolsAPI key

20,000 free app calls every month(paid services billed separately)

Try a Ploid Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo SkillPloid

Find and research a person

Search candidates, resolve the intended person, and retrieve a reviewed profile.

/oo Ploid: Find candidates for [name and company] in Ploid, show the matches so I can identify the intended person, then retrieve the selected profile and summarize its public evidence.

Fill a research dataset

Add sourced values to existing people or company rows.

/oo Ploid: Use Ploid to fill [columns] for [rows]. Start an asynchronous dataset, wait for completion, then page through every result and distinguish found, uncertain, and missing cells.

Start Working with Ploid

  1. Install OOMOL

    Set up oo CLI and the oo Skill in your agent.

    Install OOMOL →
  2. Connect Ploid

    Create an API key at https://app.ploid.com/workspace/settings?section=api-keys.

    Connect Ploid→
  3. Give Your Agent a Task

    Use /oo with the pages to read, the changes to make, and where to save the result.

    Connection Guide →
  • A Ploid workspace and API key with account:read for connection verification.
  • The scopes and available ACU required by the actions you use.
  • Some operations consume workspace credits and are subject to key budgets.
  • People Sets are preview; GitHub search is beta. Availability depends on your workspace.
  • Research results are evidence-based assessments, not identity verification.

Ploid Tools

Ploid combines people search, identity resolution, public social profiles, contact enrichment, datasets, and scheduled monitoring. Durable research can be followed through status and paginated result actions.

People and social research

Search, resolve, and enrich people using public professional and social sources.

Datasets and People Sets

Build durable criteria-verified lists or fill rows with evidence-backed columns.

Scheduled monitoring

Compile, create, run, and inspect monitors, including webhook delivery tests.

Account and harness

Read usage and budgets, manage the account profile, and request contextual chat completions.

47 tools

Search People Candidates

Return up to 10 basic indexed profiles matching all name terms plus optional company, location, and title filters. Requires people:search; legacy full-access keys with both people:enrich and agent:chat are accepted. Costs 1 ACU per completed search, including zero matches; failed searches are not charged. Never starts research or enrichment. Normal account billing, auto-recharge settings, and API-key spending caps apply. Send an Idempotency-Key to replay a request without another charge. Indexed identities and employment are unverified. Ask the user to choose before POST /v1/person, which costs 25 ACU unless the workspace already has active access. One bounded index request; no exhaustive count or pagination. Workspace limits: 30 requests/minute and 300/hour across keys. Active account eligibility still applies.

ploid.search_people_candidates

Get Open Api Document

Returns this OpenAPI 3.1 contract. No authentication is required.

ploid.get_open_api_document

Get Harness Context

Returns the calling user's bounded Ploid user, company, and relevant memory context without running a model. Requires agent:chat.

ploid.get_harness_context

Create Harness Chat Completion

Create a non-streaming chat completion with Ploid model routing and tool definitions. Requires agent:chat. The upstream enforces its current payload and tool limits.

ploid.create_harness_chat_completion

Sync People Search

Retrieve up to 150 people inline per request; async:true or a larger num_results starts a background People Set instead and returns 202 with set_id, items_url and events_url. instant returns indexed candidates as ranked by the index. fast compiles the query, reads a pool of at least 200 indexed candidates (three times num_results when that is larger) and ranks them by the stated role, place, employer, keywords, industry and seniority before returning the first num_results, without web verification. auto and deep research the complete query and explicit filters before returning matches with verification references; uncertain and rejected candidates are excluded from results, grounding and billing. Auto/deep compile the query, verify candidates, and run one bounded web recovery pass when too few match. Each verification pass permits up to 30 seconds for auto or 45 seconds for deep; recovery discovery permits 45 or 60 seconds respectively; the whole verification stage answers within 60 seconds for auto and 120 seconds for deep. A partial status means the requested count was not filled or verification hit its deadline; coverage.has_more says more candidates remained. Use Sets for durable research of large result sets. Verification is evidence-based model assessment, separate from identity verification. Requires people:search.

ploid.sync_people_search

List Company Recruiters

Merges live LinkedIn search, web search results, and the Ploid people index to return recruiters, role counts, and whether each count is complete. Placeholder company names are skipped. Up to 10 companies per request; each unique non-placeholder company is billed for returned matches. Requires people:search.

ploid.list_company_recruiters

Resolve Person

Identify one person from a full name plus at least one clue (company name or domain, role, location, address, work or personal email, or phone) by fusing the people index with live web results. Returns the permanent person_id accepted by /v1/person and /v1/enrich, so a deep profile is only bought for the right person. Costs 2 ACU when a person is found; no match is free. A match is model-assessed, not identity-verified. Requires people:search.

ploid.resolve_person

Get Person

Resolve one reviewed deep person profile. An eligible cached profile returns 200, including stale data with a queued refresh. Unseen people and snapshots requiring new review return a durable 202 run. Fresh research can take minutes; poll the returned run ID. A completed uncertain identity returns data:null with meta.resolution=unsure and reason ambiguous_identity or insufficient_evidence. The first successful profile costs exactly 25 ACU on every plan; organization-wide rereads are free for 90 days. Failed, uncertain, and not-found runs are free. Current role fields, age, and social audience/activity metrics are not populated by the current reviewed projection.

ploid.get_person

Get Person Run

Poll a deep person run

ploid.get_person_run

Cancel Person Run

Cancel a deep person run

ploid.cancel_person_run

Compile Monitor

Compiles a natural-language query into targets, events and relevance criteria, and derives an output schema when `output.type` is `object` without a schema. Creates nothing. Compile and create cost 1 ACU. Each run costs 1 ACU per target fetched plus 1 ACU per emitted item. Baseline runs emit nothing.

ploid.compile_monitor

Create Monitor

Creates a scheduled monitor over LinkedIn, X, Instagram and TikTok and starts a silent baseline run. `meta.baseline_run_id` identifies that run; `meta.unresolved` lists mentions that could not be turned into a target. Compile and create cost 1 ACU. Each run costs 1 ACU per target fetched plus 1 ACU per emitted item. Baseline runs emit nothing.

ploid.create_monitor

List Monitors

List monitors

ploid.list_monitors

Get Monitor

Get a monitor

ploid.get_monitor

Update Monitor

Changing `query` recompiles the plan; passing `plan` replaces the targets. Either starts a new baseline run.

ploid.update_monitor

Delete Monitor

Delete (disable) a monitor

ploid.delete_monitor

Run Monitor

Trigger a run now

ploid.run_monitor

Test Monitor

Dry run. Fetches the monitor's targets now, judges recent activity against the query, and returns up to max_items_per_run relevant items, newest first. Nothing is saved: no run, no items, no seen-ledger or snapshot change, no webhooks, and the schedule is untouched. `already_seen` marks items an earlier run already recorded, which a real run would not send again. Works before and after the baseline. Costs 1 ACU per target fetched; no item or output-extraction charge (items carry `source`, not `output`).

ploid.test_monitor

Test Monitor Webhook

Posts a `monitor.webhook.test` event to webhook_url right away, signed with webhook_secret when set, and returns the HTTP outcome. One attempt, no retries, no ACU.

ploid.test_monitor_webhook

List Monitor Runs

List runs

ploid.list_monitor_runs

Get Monitor Run

Get a run

ploid.get_monitor_run

List Monitor Items

List emitted items

ploid.list_monitor_items

Create Dataset

Seed up to 25 rows (sync) or 2000 rows (async) of people, companies, or custom entities, and name up to 30 columns. Every cell is fused from many sources into one answer with a 0..1 confidence and public evidence URLs. Sync requests answer within deadline_ms (default 20000); cells still running at the deadline return status timeout. mode async returns 202 and fills rows in the background; poll GET /v1/datasets/{id} and page rows_url. Pay on hit: 1 ACU per 10 found standard cells (rounded up per request), 1 ACU per found custom cell, 1 ACU per work email, 3 ACU per personal email, 10 ACU per phone. not_found, unverified, and timeout cells are free. The API key reserves the all-found upper bound and releases the rest after the run. Requires people:search.

ploid.create_dataset

Get Dataset

Status, columns, and progress of a dataset owned by the caller's workspace. Requires people:search.

ploid.get_dataset

List Dataset Rows

Rows in seed order with their cells. Usable while an async dataset runs; pending rows report timeout cells until filled. Requires people:search.

ploid.list_dataset_rows

Search Github Accounts

Filter Ploid's GitHub accounts index. Every criterion is AND; give at least one. Results come back by relevance when query or company is set, otherwise by merged pull requests and then commits; sort picks an activity ranking instead. Page with offset up to 1000 results deep; the last page before that shrinks to fit, so next_offset can always be followed with the same limit. With include_profiles, each account also carries its live public GitHub profile (limit defaults to and may not exceed 10). Costs 1 ACU per completed search plus 1 ACU per live profile found, charged together; failed searches are not charged. Emails and phone numbers are never returned. Requires people:search.

ploid.search_github_accounts

Search Github People

Run a GitHub accounts search, read each account's live public profile, and tie it to a LinkedIn profile: one the user lists on GitHub, or the one indexed person whose name matches and whose employer or location agrees. Ambiguous matches are left unlinked. linkedin filters are hard: a person is returned only when their linked, indexed LinkedIn profile satisfies every one. Pages advance over GitHub accounts (scanned), so a page can return fewer people than it scanned; follow next_offset. At most 10 accounts per page. Costs 1 ACU per completed search plus 1 ACU per returned person, charged together; failed searches are not charged. Emails and phone numbers are never returned. Requires people:search.

ploid.search_github_people

Enrich Social Profile

Resolve a public profile from a supported platform handle or URL. Requires the people:enrich scope.

ploid.enrich_social_profile

Get Linkedin Profile

Returns a LinkedIn profile by URL, vanity slug, or @handle. Requires the linkedin:read scope.

ploid.get_linkedin_profile

Search Linkedin People

Structured LinkedIn people search by keywords, location, title, company, and school. Requires the linkedin:read scope.

ploid.search_linkedin_people

List Linkedin Posts

Returns recent posts for a LinkedIn profile. Requires the linkedin:read scope.

ploid.list_linkedin_posts

List Linkedin Profile Comments

Identity-bound LinkedIn read. Requires the linkedin:read scope.

ploid.list_linkedin_profile_comments

Get Linkedin Company

Identity-bound LinkedIn read. Requires the linkedin:read scope.

ploid.get_linkedin_company

List Linkedin Company Posts

Identity-bound LinkedIn read. Requires the linkedin:read scope.

ploid.list_linkedin_company_posts

Enrich Person

Resolve contact fields for one person using a LinkedIn URL, permanent person_id, email (with first and last name at a work domain, or alone for a reverse lookup), or name plus company domain. Request work_email, personal_email, and/or phone; every field reports found, not_found, or unavailable with confidence, source, and last_seen. Responses include explicit usage.billed and usage.not_found. The legacy lightweight LinkedIn profile contract remains supported; use /v1/person for deep public evidence. Requires the people:enrich scope.

ploid.enrich_person

Get Credits

Returns the workspace ACU balance and budget state for the API key used on this request. Requires account:read.

ploid.get_credits

Get Account Usage

Returns workspace ACU usage plus the calling key's ID, budget, and the number of active keys. Requires account:read.

ploid.get_account_usage

Get Account Profile

Requires account:read.

ploid.get_account_profile

Update Account Profile

Requires account:write.

ploid.update_account_profile

Revoke Current Api Key

Immediately revokes the calling API key. A successful response is the final response that key can authorize. Requires account:read.

ploid.revoke_current_api_key

Create Set

Create a preview People Set and start a durable criteria-verified search. Requires people:search.

ploid.create_set

List Sets

List the most recent workspace People Sets (preview). Requires people:search.

ploid.list_sets

Get Set

Read a People Set and its searches, newest first. Inspect searches for progress and stop_reason (preview).

ploid.get_set

List Set Items

Page admitted people from a People Set, including partial results while a search runs (preview).

ploid.list_set_items

Export Set

Export admitted People Set items as JSON, preserving raw field values (preview).

ploid.export_set

Cancel Set

Cancel a running People Set search; keep already admitted people (preview).

ploid.cancel_set

Start Dataset

Start an asynchronous dataset to fill up to 2000 rows with sourced column values. Requires people:search.

ploid.start_dataset

Frequently Asked Questions

Does connecting start paid research?

No. Connecting reads the account profile. Business operations can consume ACU; set key budgets and reuse an idempotency key when retrying the same supported request.

How do long-running requests work?

Person research can return an immediate cached result or a run_id. Poll the person-run action when a handle is returned. Async datasets expose a submit/result lifecycle; People Sets provide status and paginated admitted items.