Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service Custom Enrichments API

3 actions 3 updates phrasing extends openapi/explorium-customenrichments-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/custom_enrichments/{custom_enrichment_id}/enrich'].post

$.paths['/v1/custom_enrichments/{enrichment_id}/bulk_enrich'].post

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 Partner Service Custom Enrichments API
  version: 1.0.0
extends: openapi/explorium-customenrichments-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: 2
- target: $.paths['/v1/custom_enrichments/{custom_enrichment_id}/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a custom enrichment on one business
      effect: read
      questions:
      - Can I apply my own custom enrichment to a single company?
      - What does a custom enrichment return for one business?
      instructions:
      - text: Run custom enrichment {custom_enrichment_id} on business {business_id}.
        slots:
          custom_enrichment_id: path.custom_enrichment_id
          business_id: requestBody.business_id
      - text: Enrich company {business_id} using my custom enrichment {custom_enrichment_id}.
        slots:
          custom_enrichment_id: path.custom_enrichment_id
          business_id: requestBody.business_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/custom_enrichments/{enrichment_id}/bulk_enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a custom enrichment on many businesses
      effect: read
      questions:
      - Can I run a custom enrichment across a batch of companies in one request?
      - How do I bulk-apply my custom enrichment to several business IDs?
      instructions:
      - text: Run custom enrichment {enrichment_id} on businesses {business_ids}.
        slots:
          enrichment_id: path.enrichment_id
          business_ids: requestBody.business_ids
      - text: Bulk-enrich {business_ids} with my custom enrichment {enrichment_id}.
        slots:
          enrichment_id: path.enrichment_id
          business_ids: requestBody.business_ids
      method: generated
      generated: '2026-10-01'