# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Intellectual Property (IP) Data Trademarks API
  version: 1.0.0
extends: openapi/clarivate-trademarks-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: 3
- target: $.paths['/trademarks/document/json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several trademark documents by GUID
      effect: read
      questions:
      - How do I retrieve multiple full trademark records in one call?
      - Can I limit the fields returned for a batch of trademarks?
      instructions:
      - text: Fetch trademark documents {GUIDS}.
        slots:
          GUIDS: requestBody.GUIDS
      - text: Get trademarks {GUIDS} with only fields {FIELDS}.
        slots:
          GUIDS: requestBody.GUIDS
          FIELDS: requestBody.FIELDS
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trademarks/document/json/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one full trademark document
      effect: read
      questions:
      - How do I look up a single trademark record by its GUID?
      - Where can I get the full JSON for one registered mark?
      instructions:
      - text: Get trademark document {document_guid}.
        slots:
          document_guid: path.document_guid
      - text: Show the full trademark record for GUID {document_guid}.
        slots:
          document_guid: path.document_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/trademarks/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and aggregate trademarks
      effect: read
      questions:
      - How do I search trademarks and group the results?
      - Can I page through trademark search results?
      instructions:
      - text: Search trademarks for {QUERY}.
        slots:
          QUERY: requestBody.QUERY
      - text: Search trademarks matching {QUERY} aggregated by {AGG}.
        slots:
          QUERY: requestBody.QUERY
          AGG: requestBody.AGG
      method: generated
      generated: '2026-09-26'