Hightouch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hightouch Idr API

5 actions 5 updates phrasing extends openapi/hightouch-idr-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Hightouch's API. It is a proposal applied on top of the contract, not a document Hightouch publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/idr/{graphId}/trigger'].post

$.paths['/idr/{graphId}/runs'].get

$.paths['/idr/{graphId}/queue-for-reprocessing'].post

$.paths['/idr/{graphId}/reprocess-status/{requestId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hightouch Idr API
  version: 1.0.0
extends: openapi/hightouch-idr-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/idr/{graphId}/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an identity resolution run
      effect: write
      questions:
      - How do I trigger a new identity resolution run for a graph?
      - Can I force a full rerun of the identity graph instead of an incremental one?
      instructions:
      - text: Trigger an IDR run for graph {graphId}.
        slots:
          graphId: path.graphId
      - text: Start a full identity resolution rerun of graph {graphId} ({fullRerun}).
        slots:
          graphId: path.graphId
          fullRerun: requestBody.fullRerun
      method: generated
      generated: '2026-10-01'
- target: $.paths['/idr/{graphId}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity resolution runs for a graph
      effect: read
      questions:
      - What identity resolution runs have happened on my graph recently?
      - Can I see IDR runs that started within a date range?
      instructions:
      - text: List IDR runs for graph {graphId}.
        slots:
          graphId: path.graphId
      - text: Show IDR runs for graph {graphId} started after {after} and before {before}.
        slots:
          graphId: path.graphId
          after: query.after
          before: query.before
      - text: Find IDR run {runId} on graph {graphId}.
        slots:
          runId: query.runId
          graphId: path.graphId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/idr/{graphId}/queue-for-reprocessing'].post
  update:
    x-apievangelist-phrasing:
      intent: Blocklist and reprocess identifier values
      effect: write
      questions:
      - How do I remove a bad email from identity resolution so it's ignored in future runs?
      - Can I reprocess clusters for certain identifiers without adding them to the blocklist?
      instructions:
      - text: Queue identifiers {identifiers} in graph {graphId} for reprocessing and blocklist them.
        slots:
          identifiers: requestBody.identifiers
          graphId: path.graphId
      - text: Reprocess identifiers {identifiers} in graph {graphId} with blocklisting set to {block}.
        slots:
          identifiers: requestBody.identifiers
          graphId: path.graphId
          block: requestBody.block
      method: generated
      generated: '2026-10-01'
- target: $.paths['/idr/{graphId}/reprocess-status/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a reprocessing request
      effect: read
      questions:
      - Has my identifier reprocessing job finished yet?
      - What is the status of a queued reprocessing request on an identity graph?
      instructions:
      - text: Get the status of reprocessing request {requestId} on graph {graphId}.
        slots:
          requestId: path.requestId
          graphId: path.graphId
      - text: Check whether reprocessing request {requestId} for graph {graphId} is done.
        slots:
          requestId: path.requestId
          graphId: path.graphId
      method: generated
      generated: '2026-10-01'