# 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 Derwent API
  version: 1.0.0
extends: openapi/clarivate-derwent-api-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: 17
- target: $.paths['/ip/patents/derwent/document/images/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Derwent patent's image URLs (JWT route)
      effect: read
      questions:
      - How do I get the drawing image URLs for a Derwent patent using JWT authentication?
      - Can I request only the front page image of a patent on the JWT-authenticated IP route?
      instructions:
      - text: Get image URLs for Derwent document {document_guid} via the JWT /ip route.
        slots:
          document_guid: path.document_guid
      - text: Fetch front-page-only images for patent {document_guid} at size {size} on the JWT-authenticated route.
        slots:
          document_guid: path.document_guid
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ip/patents/derwent/document/images/{document_guid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch-fetch Derwent image URLs (JWT route)
      effect: read
      questions:
      - Can I fetch image URLs for several Derwent patents in one POST using JWT auth?
      - How do I request inline images for a batch of publication numbers on the JWT IP endpoint?
      instructions:
      - text: Get Derwent image URLs for patents {params} with a POST on the JWT /ip route.
        slots:
          params: requestBody.params
      - text: POST to the JWT image route for document {document_guid}, requesting all drawings for publications {params}.
        slots:
          document_guid: path.document_guid
          params: requestBody.params
      method: generated
      generated: '2026-10-01'
- target: $.paths['/patents/derwent/class-browse'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse a patent classification hierarchy
      effect: read
      questions:
      - How do I see the child codes under an IPC classification code in Derwent?
      - Can I walk the hierarchy of a patent classification scheme like IPC8?
      instructions:
      - text: Browse the classification hierarchy under code {params}.
        slots:
          params: requestBody.params
      - text: Show the hierarchical code list for IPC8 class {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/class-search'].post
  update:
    x-apievangelist-phrasing:
      intent: Find classification codes by keyword
      effect: read
      questions:
      - Which patent classification codes match a keyword like battery electrode?
      - How do I turn a keyword into IPC classification codes in Derwent?
      instructions:
      - text: Search classification codes matching keyword {params}.
        slots:
          params: requestBody.params
      - text: Find IPC8 codes whose descriptions mention {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/combined-search'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a combined Derwent patent search
      effect: read
      questions:
      - Can I combine several saved patent queries into one Derwent search?
      - How do I search patents using a combination of queries?
      instructions:
      - text: Run a combined Derwent search over queries {params}.
        slots:
          params: requestBody.params
      - text: Combine these patent search queries {params} and return the result set.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/corporate-tree'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up companies in the corporate tree
      effect: read
      questions:
      - How do I find a company's subsidiaries in the Derwent corporate tree?
      - Can I look up an assignee by code or name and get its corporate hierarchy?
      instructions:
      - text: Look up {params} in the Derwent corporate tree.
        slots:
          params: requestBody.params
      - text: Show the corporate tree structure for assignee code {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/document/images'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch-fetch Derwent patent image URLs
      effect: read
      questions:
      - How do I get image URLs for many Derwent patents in one request?
      - Can I ask for only inline images for a list of publication numbers?
      instructions:
      - text: Get image URLs for these Derwent patents {params}.
        slots:
          params: requestBody.params
      - text: Fetch front-page images only for patent IDs {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/document/images/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List image URLs for one Derwent patent
      effect: read
      questions:
      - Where can I get the drawings of a single Derwent patent as image URLs?
      - Can I choose the image size and format for a patent's pictures?
      instructions:
      - text: List image URLs for Derwent patent {document_guid}.
        slots:
          document_guid: path.document_guid
      - text: Get images of document {document_guid} in {format} format.
        slots:
          document_guid: path.document_guid
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/document/pdf'].post
  update:
    x-apievangelist-phrasing:
      intent: Get PDF links for several Derwent patents
      effect: read
      questions:
      - How do I check which Derwent patents have PDFs available and get their download links?
      - Can I get wrapped PDF URLs instead of direct DocDel links for a batch of patents?
      instructions:
      - text: Get PDF download links for Derwent patents {params}.
        slots:
          params: requestBody.params
      - text: Check PDF availability for patents {params} and return wrapped URLs.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/document/pdf/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the PDF of one Derwent patent
      effect: read
      questions:
      - How do I download the full PDF for a single Derwent patent document?
      - Can I fetch a patent PDF directly by its document GUID?
      instructions:
      - text: Download the PDF of Derwent document {document_guid}.
        slots:
          document_guid: path.document_guid
      - text: Fetch the patent PDF file for GUID {document_guid}.
        slots:
          document_guid: path.document_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/documents-IdMapping'].post
  update:
    x-apievangelist-phrasing:
      intent: Map publication numbers to Derwent GUIDs
      effect: read
      questions:
      - How do I convert patent publication numbers into Derwent document GUIDs?
      - Can I map a list of external patent IDs to Derwent-format identifiers?
      instructions:
      - text: Map these publication numbers {params} to Derwent GUIDs.
        slots:
          params: requestBody.params
      - text: Generate Derwent-format GUIDs for patent IDs {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/documents-by-id'].post
  update:
    x-apievangelist-phrasing:
      intent: Download Derwent documents by GUID
      effect: read
      questions:
      - How do I download full Derwent patent records when I already have their GUIDs?
      - Can I pull several Derwent documents at once by document GUID?
      instructions:
      - text: Download Derwent documents for GUIDs {params}.
        slots:
          params: requestBody.params
      - text: Retrieve the full Derwent records with document IDs {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/documents-by-listref'].post
  update:
    x-apievangelist-phrasing:
      intent: Download documents from a saved LISTREF
      effect: read
      questions:
      - How do I download document fields for the patents stored in a Derwent LISTREF?
      - Can I export records from a result list reference instead of listing GUIDs?
      instructions:
      - text: Download document fields for everything in LISTREF {params}.
        slots:
          params: requestBody.params
      - text: Export the Derwent records saved under list reference {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/documents-by-pn'].post
  update:
    x-apievangelist-phrasing:
      intent: Download Derwent documents by patent number
      effect: read
      questions:
      - How do I download Derwent patent records using publication numbers like US1234567B2?
      - Can I fetch full documents for a list of patent numbers?
      instructions:
      - text: Download Derwent documents for patent numbers {params}.
        slots:
          params: requestBody.params
      - text: Retrieve full records for publications {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/search-by-ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Derwent by document GUIDs
      effect: read
      questions:
      - How do I run a Derwent search restricted to a known set of document GUIDs?
      - Can I get a search result set built from Derwent GUIDs?
      instructions:
      - text: Search Derwent using document GUIDs {params}.
        slots:
          params: requestBody.params
      - text: Build a Derwent result set from these GUIDs {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/search-by-pns'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Derwent by patent numbers
      effect: read
      questions:
      - How do I run a Derwent search from a list of patent or publication numbers?
      - Can I get a result set for patent numbers without downloading the documents?
      instructions:
      - text: Search Derwent for patent numbers {params}.
        slots:
          params: requestBody.params
      - text: Create a search result set from publication numbers {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/derwent/search-by-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Derwent patents with a query
      effect: read
      questions:
      - How do I search Derwent patents with a query string?
      - What query syntax does the Derwent search endpoint accept for finding inventions?
      instructions:
      - text: Search Derwent patents with query {params}.
        slots:
          params: requestBody.params
      - text: Find inventions matching the search expression {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'