# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 6sense Company API
  version: 1.0.0
extends: openapi/6sense-company-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: 7
- target: $.paths['/v3/company/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify a company from a visitor IP address
      effect: read
      questions:
      - Which company is behind the IP address visiting my website?
      - Can I get a visitor's buying stage and profile fit from just their IP in 6sense?
      - What firmographics and segment memberships come back when I look up an IP address?
      instructions:
      - text: Identify the company behind IP address {ip}.
        slots:
          ip: query.ip
      - text: Look up firmographics, buying stage and segments for visitor IP {ip} using tracking cookie {cookie}.
        slots:
          ip: query.ip
          cookie: header.EpsilonCookie
      - text: Resolve IP {ip} to a company and tag the request with my custom ID {custom_id}.
        slots:
          ip: query.ip
          custom_id: header.X-6s-CustomID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/company/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List the products on my company API account
      effect: read
      questions:
      - Which products are enabled for my company API account?
      - What product list does the company products endpoint return for me?
      instructions:
      - text: List the products available to my company API account.
      - text: Show me which company API products I have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/v1/segment/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the accounts in a segment (company/v1 route)
      effect: read
      questions:
      - How can I pull every account that belongs to one of my segments through the /company/v1/segment route?
      - Which companies are in a given segment when I call the company/v1 segment path?
      instructions:
      - text: List the accounts in segment {segment_id} using the /company/v1/segment route.
        slots:
          segment_id: path.segment_id
      - text: Pull the company/v1 account list for segment {segment_id}.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/company/v1/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List my segments (company/v1 route)
      effect: read
      questions:
      - What segments do I have when I call the /company/v1/segments route?
      - Where can I see all my segments through the company/v1 path?
      instructions:
      - text: List my segments using the /company/v1/segments route.
      - text: Fetch all segments from the company/v1 segments path.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/company/segment/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the accounts in a segment (v1/company route)
      effect: read
      questions:
      - How do I get the accounts in a segment through the /v1/company/segment route?
      - Which companies does the v1/company segment path return for one segment?
      instructions:
      - text: Using the version-first route, show which accounts belong to segment {segment_id}.
        slots:
          segment_id: path.segment_id
      - text: Get segment {segment_id}'s account membership from the endpoint that starts with v1.
        slots:
          segment_id: path.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/company/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List my segments (v1/company route)
      effect: read
      questions:
      - What segments come back from the /v1/company/segments route?
      - Can I list all my segments through the v1/company path?
      instructions:
      - text: Using the version-first route, show every segment I own.
      - text: Get my segment catalog from the endpoint that starts with v1.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/company/validate_access/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that my token can access segments
      effect: read
      questions:
      - Does my API token actually have access to segments?
      - How can I verify segment access before I start pulling segment accounts?
      instructions:
      - text: Validate that my credentials have access to segments.
      - text: Run the segment access check for my account.
      method: generated
      generated: '2026-09-26'