CatchAll

Map a resource (job, monitor, or monitor_group) to a webhook.Use when:- You want a webhook to fire for a specific job or monitor's deliveries.

Check API health status.This tool maps to GET /health and does not require an API key.

Expand a job by processing more records beyond the initial limit.This increases the number of records the system processes (which costsadditional credits). Only use this when the user wants MORE data processed.This only applies to jobs originally submitted with `limit`.If a job was submitted without `limit`, there is nothing to continue.The new_limit must be greater than the previous limit when provided.If omitted, API defaults to your plan maximum.

Create a new dataset.Datasets are collections of entities (companies/people). Connect a dataset toa job via `submit_query(connected_dataset_ids=[...])` to narrow retrieval scope.

Create a new dataset by uploading a CSV file.The CSV must have at least a `name` column. For meaningful entityenrichment each row should also include a `domain` column or a`description` column (or both) — a row with only a name is accepted butproduces lower-quality enrichment. Additional columns are mapped to entityattributes. Max file size is plan-dependent. To add CSV rows to anexisting dataset, use `append_csv_to_dataset` instead.

Create multiple entities in one call.

Create a single entity (a company or person).``name`` is required plus at least one identifyingfield: either ``description`` or ``additional_attributes.company_attributes.domain``.

Create a recurring monitor from a completed job.Monitors re-run a job's query on a schedule. Use the explore -> refine -> automatepattern: submit a job, refine until results match, then create a monitor.The schedule is defined in natural language (e.g., 'every day at 9 AM EST').Always include a timezone (in the schedule text or via the `timezone` arg).API-enforced constraints apply:- If `backfill=true`, reference job end_date must be within the last 7 days- If `backfill=false`, reference job age…

Create a new project.Projects group related resources (jobs, monitors, datasets, monitor_groups)so you can organize work and filter listings by `project_id`.

Create a new webhook endpoint.Use when:- You want to register a URL to receive job or monitor result deliveries.- You need a webhook_id to attach to a monitor (via webhook_ids) or a job submission.

Permanently delete a dataset.The entities the dataset referenced are not deleted; only the dataset and itsentity associations are removed.

Permanently delete an entity.

Permanently delete a job and its results.Use when:- You want to remove a job you no longer need from your account.

Permanently delete a monitor and stop its scheduled runs.Use when:- You want to remove a monitor entirely (use `disable_monitor` to only pause it).

Delete a project.By default the project's resources (jobs, monitors, etc.) are detached butkept. Set `delete_resources=true` to also delete the contained resources.

Permanently delete a webhook endpoint.Use when:- You want to remove a webhook from your account.

Disable a monitor to stop its scheduled runs.The monitor can be re-enabled later with enable_monitor.

Enable a previously disabled monitor to resume its scheduled runs.

Get a single dataset's details.

Get the status history of a dataset (e.g. its enrichment progress over time).

Get a single entity's details.

Check the status of a submitted job.Call this after submit_query to see if your job is ready.Status progression: submitted -> analyzing -> fetching -> clustering -> enriching -> completed/failedIMPORTANT: Jobs take several minutes to process.First check after ~1-2 minutes, then poll every 30-60 seconds.Broad searches can take 10-30+ minutes; for long jobs, poll every 60-120 seconds.Do NOT call this tool in a tight loop.Stop polling when status is `completed` or `failed`.Treat `submitted`, `analy…

Get the status history of a monitor.Use when:- You want to see the timeline of a monitor's state changes (e.g. active, disabled, errored) and any related details.

Get a single project's details.

Get a project's resource overview (counts grouped by resource type and status).

Retrieve plan features and current usage limits for your API key.Use when:- You want to know how many records/jobs/monitors your plan allows.- You want to check current usage against plan limits before running a large job.

Get current API version.This tool maps to GET /version and does not require an API key.

Retrieve the full configuration of a specific webhook.Use when:- You want to inspect a webhook's URL, method, headers, or status by its ID.

Get the webhook delivery history for a resource (job/monitor/monitor_group).Use when:- You want to see past webhook delivery attempts and their outcomes for a specific job or monitor.

Preview suggested validators, enrichments, and date ranges before submitting.Use when:- You want to inspect/edit auto-generated validators/enrichments before submitting.- You want to preview date adjustments via `date_modification_message`.Do not use when:- You want to start processing immediately with final inputs (use `submit_query`).Key behavior:- Preview-only endpoint: does not create a job and does not start processing.- Suggestions are LLM-generated and not deterministic across calls.- To …

List the entities contained in a dataset.

List your datasets.

List your entities.

List all jobs spawned by a monitor.Returns the history of scheduled runs for a monitor.

List all your monitors.Returns all monitors with their schedule, status, reference query, and webhook config.

List the resources contained in a project.

List your projects.

List the webhooks mapped to a specific resource (job/monitor/monitor_group).Use when:- You have a job or monitor ID and want to know which webhooks will fire for it.

List all jobs submitted by you.Returns your job history with IDs, queries, statuses, and timestamps.

List the resources mapped to a webhook.Use when:- You want to see which jobs/monitors a webhook is attached to.

List all your webhooks.Use when:- You want to see all webhook endpoints configured in your account.- You need to find a webhook_id to pass to monitors (via webhook_ids) or jobs.

Download a job's results as a CSV file.Use when:- You want the full job output as a CSV for offline analysis or export.- Prefer this over `pull_results` when the consumer needs spreadsheet/CSV format.

Download the latest monitor run's results as a CSV file.Use when:- You want the most recent monitor run output as a CSV for offline analysis or export.- Prefer this over `pull_monitor_results` when the consumer needs spreadsheet/CSV format.

Retrieve the latest results from a monitor.Returns the most recent run's results including run_info, records, and all_records.

Retrieve the results of a job.Can be called before completion for partial results, or after completionfor the full set. Returns clustered, validated, and enriched web results.While job status is active, call this repeatedly (typically page=1) torefresh partial output. When job reaches completed, iterate all pages.If job fails, call once more to capture any partial output.

Remove entities from a dataset (the entities themselves are not deleted).

Remove a single resource from a project.

Unmap a resource from a webhook.Use when:- You want to stop a webhook from firing for a specific job or monitor.

Create a new CatchAll processing job from a natural-language query.Use when:- You want to start a new CatchAll web research run from a user query.- You want the API to fetch/process sources and then return structured results.Do not use when:- You want status for an existing job (use `get_job_status`).- You want records for an existing job (use `pull_results`).Key rules:- `query` is required.- You can submit with only `query`; omitted optional fields (`validators`, `enrichments`, `start_date`, `e…

Send a test delivery to a webhook endpoint.Use when:- You want to verify a webhook URL is reachable and correctly configured before attaching it to a monitor or job.

Manually trigger webhook delivery for a resource (job/monitor/monitor_group).Use when:- You want to (re-)send a webhook delivery on demand instead of waiting for the automatic dispatch — e.g. to replay a missed or failed delivery.

Update a dataset's name and/or description.

Update an entity's name, description, external_entity_id, and/or attributes.

Update a monitor's webhook assignments and per-run limit.Note: schedule and reference_job_id cannot be modified through this endpoint.Webhooks are centralized — pass webhook IDs (from `create_webhook`/`list_webhooks`).

Update a project's name and/or description.Only the fields you provide are changed.

Update an existing webhook's configuration.Use when:- You want to change a webhook's URL, method, headers, or other settings.- You want to enable or disable a webhook (set `is_active`).- Only the fields you provide are updated; omitted fields remain unchanged.

Check the quality of a query before submitting a job ("Check Query Quality").Use when:- You want quick feedback on whether a query is well-formed for CatchAll before spending credits on a job.- You want concrete suggestions to improve a vague or overly broad query.Do not use when:- You want to preview auto-generated validators/enrichments (use `initialize_query`).- You want to actually run a search (use `submit_query`).