correlation

Submit cross-domain correlation

Submit 2-100 domains for cross-domain correlation analysis.

Creates a background job to analyze uncached domains, compute pairwise correlation scores, detect clusters, and generate LLM summaries.

Correlation is a credit-billed product available to any account with sufficient credits (no subscription tier required — Gap G, Option A).

Credit billing: 1 credit per uncached domain + 1 for the correlation compute, debited as ONE job-keyed charge (single settlement; exactly-once via the charge:{job_id} ledger idempotency key). The charge is refunded via the keyed settle path if dispatch fails or the job ends failed.

post/correlate

Request

  • Base URL: https://api.whoisgeni.us (the document declares no server; this is the origin it was published from)
  • URL: https://api.whoisgeni.us/correlate
  • Auth: none declared

Headers

X-API-Keystring nullable

Request body

domainsstring[] required
callback_urlstring nullable

Optional URL to receive a webhook POST when correlation completes

Example request

{
  "callback_url": "https://example.com/webhook",
  "domains": [
    "example.com",
    "example.org"
  ]
}

Response

Correlation job accepted

metaobject nullable

Example response

{
  "data": {
    "correlation_id": "3f6b8c2a-7a1d-4e5f-9b0c-2d4e6f8a0b1c",
    "credits_charged": 4,
    "domain_count": 7,
    "domains_cached": 4,
    "domains_to_analyze": 3,
    "job_id": "3f6b8c2a-7a1d-4e5f-9b0c-2d4e6f8a0b1c",
    "poll_url": "/correlate/3f6b8c2a-7a1d-4e5f-9b0c-2d4e6f8a0b1c",
    "status": "pending"
  },
  "error": {
    "code": "JOB_NOT_FOUND",
    "message": "No job found with the given ID."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.