Create ICP Mining

Create an ICP mining run in Finder. Pass filters using finder field names: person_industries, person_locations, person_skills (number[] IDs from getFinderCategoryIds), organization_domains (string[]), organization_industries, organization_locations (number[] IDs), role_title, role_description. Use getFinderCategoryIds first for industries/locations/skills. At least one filter required. Optional: name, segment_id, total_targets.

Input Schema

Parameter	Type	Description
query	object	Filters object. Keys: person_industries, person_locations, person_skills (number[] IDs), organization_domains (string[]), organization_industries, organization_locations, role_title, role_description. At least one filter required.
person_industries	array	Industry IDs from getFinderCategoryIds
person_locations	array	Location IDs from getFinderCategoryIds
person_skills	array	Skill IDs from getFinderCategoryIds
organization_domains	array	Company domains e.g. [“example.com”]
organization_industries	array	Organization industry IDs
organization_locations	array	Organization location IDs
organization_keywords	array	Organization keyword IDs
organization_web_technologies	array	Web technology IDs
role_title	string	Job title filter
role_description	string	Role/job description filter
name	string	Optional name for the ICP mining run
segment_id	string	Optional segment UUID
total_targets	number	Optional estimated total targets count

REST Endpoint


POST /api/agents/tools/createIcpMining

The site_id field is required when calling via REST. At least one filter must be provided.


POST /api/agents/tools/createIcpMining
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
 
{
  "site_id": "YOUR_SITE_ID",
  "name": "Tech Engineers in NYC",
  "person_industries": [123],
  "person_locations": [789],
  "role_title": "Software Engineer",
  "segment_id": "SEGMENT_UUID"
}

Response:


{
  "success": true,
  "mining_id": "...",
  "status": "queued"
}