Coresignal · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Coresignal Multi-source Company Search API

3 actions 3 updates phrasing extends openapi/coresignal-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Coresignal's API. It is a proposal applied on top of the contract, not a document Coresignal publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/search/filter'].post
$.paths['/search/es_dsl'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Coresignal Multi-source Company Search API
  version: 1.0.0
extends: openapi/coresignal-search-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['/search/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Find companies matching simple filters
      effect: read
      questions:
      - How do I find companies in a given industry and country without writing an Elasticsearch query?
      - Can I filter companies by headcount range and founding year?
      - Which companies use a particular technology, and can I get their IDs?
      - Does the filter search return full company records or only matching IDs?
      instructions:
      - text: Find IDs of {industry} companies based in {country}.
        slots:
          industry: requestBody.industry
          country: requestBody.country
      - text: Filter for companies with between {employees_count_from} and {employees_count_to} employees that use {technologies}.
        slots:
          employees_count_from: requestBody.employees_count_from
          employees_count_to: requestBody.employees_count_to
          technologies: requestBody.technologies
      - text: Search for companies named {name} founded between {founded_from} and {founded_to}.
        slots:
          name: requestBody.name
          founded_from: requestBody.founded_from
          founded_to: requestBody.founded_to
      - text: List company IDs in region {region} with company size {size}.
        slots:
          region: requestBody.region
          size: requestBody.size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/search/es_dsl'].post
  update:
    x-apievangelist-phrasing:
      intent: Search companies with an Elasticsearch DSL query
      effect: read
      questions:
      - Can I send my own Elasticsearch DSL query to search Coresignal's company data?
      - What do I use when the structured filters aren't expressive enough and I need bool and nested queries?
      instructions:
      - text: Run this Elasticsearch DSL query against the company records and return the matches.
      - text: Search companies with a custom ES DSL query body instead of the simple filter fields.
      method: generated
      generated: '2026-10-01'