6sense · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 6sense People API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v2/people/search'].post
$.paths['/v2/people/search/dictionary'].get
$.paths['/v2/people/enrichment'].post
$.paths['/v2/people/score'].post
$.paths['/v2/people/full'].post
$.paths['/v2/people'].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 6sense People API
  version: 1.0.0
extends: openapi/6sense-people-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/people/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search for contacts at a company
      effect: read
      questions:
      - How do I find contacts who work at a specific company domain?
      - Can I narrow a people search by job level, function and location?
      - Is there a way to cap how many contact profiles a people search returns?
      instructions:
      - text: Find people who work at {domain}.
        slots:
          domain: requestBody.domain
      - text: Search {domain} for contacts with job title {job_title} in {location}.
        slots:
          domain: requestBody.domain
          job_title: requestBody.jobTitle
          location: requestBody.location
      - text: Return up to {limit} {job_level} contacts in {job_function} at {domain}.
        slots:
          limit: requestBody.limit
          job_level: requestBody.jobLevel
          job_function: requestBody.jobFunction
          domain: requestBody.domain
      - text: Search {domain} for people in the {industry} industry.
        slots:
          domain: requestBody.domain
          industry: requestBody.industry
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/people/search/dictionary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the valid people search filter values
      effect: read
      questions:
      - What job levels and job functions are valid filters in a people search?
      - Which industry values does the people search accept?
      instructions:
      - text: Show me the allowed filter values for people search.
      - text: Get the people search dictionary of job titles, functions, levels and industries.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/people/enrichment'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich people records without scoring
      effect: read
      questions:
      - How do I enrich people records without also scoring them?
      - Can I get enrichment data only for my contacts from the people API?
      instructions:
      - text: Enrich these contacts only, no scores.
      - text: Get enrichment data for these people records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/people/score'].post
  update:
    x-apievangelist-phrasing:
      intent: Score people records without enrichment
      effect: read
      questions:
      - How do I get just a score for my contacts without enrichment data?
      - Can I score people records on their own in the people API?
      instructions:
      - text: Score these contacts only, no enrichment.
      - text: Get scores for these people records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/people/full'].post
  update:
    x-apievangelist-phrasing:
      intent: Score and enrich people records together
      effect: read
      questions:
      - Can I get both scores and enrichment for my contacts in one call?
      - What does the full people endpoint return compared with scoring alone?
      instructions:
      - text: Score and enrich these contacts in one request.
      - text: Get the full score plus enrichment result for these people records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/people'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit people records to the base v2 people endpoint
      effect: read
      questions:
      - What happens when I post contacts to the base v2 people endpoint?
      - Is there a base people endpoint at /v2/people separate from score and enrichment?
      instructions:
      - text: Send these people records to the base v2 people endpoint.
      - text: Post my contacts to /v2/people.
      method: generated
      generated: '2026-09-26'