USPTO Open Data Portal API — Bulk Datasets

naftiko: 1.0.0-alpha2
info:
  label: USPTO Open Data Portal API — Bulk Datasets
  description: 'USPTO Open Data Portal API — Bulk Datasets. 2 operations. Lead operation: Search Bulk Dataset Products. Self-contained
    Naftiko capability covering one Us Patent And Trademark Office business surface.'
  tags:
  - Us Patent And Trademark Office
  - Bulk Datasets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    US_PATENT_AND_TRADEMARK_OFFICE_API_KEY: US_PATENT_AND_TRADEMARK_OFFICE_API_KEY
capability:
  consumes:
  - type: http
    namespace: uspto-open-data-portal-bulk-datasets
    baseUri: https://api.uspto.gov
    description: USPTO Open Data Portal API — Bulk Datasets business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-datasets-products-search
      path: /api/v1/datasets/products/search
      operations:
      - name: searchdatasetproducts
        method: GET
        description: Search Bulk Dataset Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
        - name: start
          in: query
          type: integer
        - name: rows
          in: query
          type: integer
    - name: api-v1-datasets-products-productIdentifier
      path: /api/v1/datasets/products/{productIdentifier}
      operations:
      - name: getdatasetproduct
        method: GET
        description: Get Bulk Dataset Product by Identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productIdentifier
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: X-API-KEY
      value: '{{env.US_PATENT_AND_TRADEMARK_OFFICE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: uspto-open-data-portal-bulk-datasets-rest
    port: 8080
    description: REST adapter for USPTO Open Data Portal API — Bulk Datasets. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/v1/datasets/products/search
      name: api-v1-datasets-products-search
      description: REST surface for api-v1-datasets-products-search.
      operations:
      - method: GET
        name: searchdatasetproducts
        description: Search Bulk Dataset Products
        call: uspto-open-data-portal-bulk-datasets.searchdatasetproducts
        with:
          q: rest.q
          start: rest.start
          rows: rest.rows
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/datasets/products/{productidentifier}
      name: api-v1-datasets-products-productidentifier
      description: REST surface for api-v1-datasets-products-productIdentifier.
      operations:
      - method: GET
        name: getdatasetproduct
        description: Get Bulk Dataset Product by Identifier
        call: uspto-open-data-portal-bulk-datasets.getdatasetproduct
        with:
          productIdentifier: rest.productIdentifier
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: uspto-open-data-portal-bulk-datasets-mcp
    port: 9090
    transport: http
    description: MCP adapter for USPTO Open Data Portal API — Bulk Datasets. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: search-bulk-dataset-products
      description: Search Bulk Dataset Products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: uspto-open-data-portal-bulk-datasets.searchdatasetproducts
      with:
        q: tools.q
        start: tools.start
        rows: tools.rows
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bulk-dataset-product-identifier
      description: Get Bulk Dataset Product by Identifier
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: uspto-open-data-portal-bulk-datasets.getdatasetproduct
      with:
        productIdentifier: tools.productIdentifier
      outputParameters:
      - type: object
        mapping: $.