Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service Entity ID Datasets API

2 actions 2 updates phrasing extends openapi/explorium-entityiddatasets-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 2

$.info

$.paths['/v2/async/entity-id-datasets/upload'].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 Entity ID Datasets API
  version: 1.0.0
extends: openapi/explorium-entityiddatasets-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: 1
- target: $.paths['/v2/async/entity-id-datasets/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file of entity IDs as a dataset
      effect: write
      questions:
      - How do I upload a list of business or prospect IDs to use in async jobs?
      - Can I name and describe an entity ID dataset when I upload it?
      instructions:
      - text: Upload {file} as a {entity_type} ID dataset named {name} described as {description}.
        slots:
          file: requestBody.file
          entity_type: requestBody.entity_type
          name: requestBody.name
          description: requestBody.description
      - text: Create a {entity_type} list called {name} from the file {file}.
        slots:
          file: requestBody.file
          entity_type: requestBody.entity_type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'