Pinecone Data Plane API — Bulk Operations

naftiko: 1.0.0-alpha2
info:
  label: Pinecone Data Plane API — Bulk Operations
  description: 'Pinecone Data Plane API — Bulk Operations. 4 operations. Lead operation: List imports. Self-contained Naftiko
    capability covering one Pinecone business surface.'
  tags:
  - Pinecone
  - Bulk Operations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PINECONE_API_KEY: PINECONE_API_KEY
capability:
  consumes:
  - type: http
    namespace: db-data-bulk-operations
    baseUri: https://{index_host}
    description: Pinecone Data Plane API — Bulk Operations business capability. Self-contained, no shared references.
    resources:
    - name: bulk-imports
      path: /bulk/imports
      operations:
      - name: listbulkimports
        method: GET
        description: List imports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Pinecone-Api-Version
          in: header
          type: string
          description: Required date-based version header
          required: true
        - name: limit
          in: query
          type: integer
          description: Max number of operations to return per page.
        - name: paginationToken
          in: query
          type: string
          description: Pagination token to continue a previous listing operation.
      - name: startbulkimport
        method: POST
        description: Start import
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Pinecone-Api-Version
          in: header
          type: string
          description: Required date-based version header
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: bulk-imports-id
      path: /bulk/imports/{id}
      operations:
      - name: describebulkimport
        method: GET
        description: Describe an import
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Pinecone-Api-Version
          in: header
          type: string
          description: Required date-based version header
          required: true
        - name: id
          in: path
          type: string
          description: Unique identifier for the import operation.
          required: true
      - name: cancelbulkimport
        method: DELETE
        description: Cancel an import
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-Pinecone-Api-Version
          in: header
          type: string
          description: Required date-based version header
          required: true
        - name: id
          in: path
          type: string
          description: Unique identifier for the import operation.
          required: true
    authentication:
      type: apikey
      key: Api-Key
      value: '{{env.PINECONE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: db-data-bulk-operations-rest
    port: 8080
    description: REST adapter for Pinecone Data Plane API — Bulk Operations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/bulk/imports
      name: bulk-imports
      description: REST surface for bulk-imports.
      operations:
      - method: GET
        name: listbulkimports
        description: List imports
        call: db-data-bulk-operations.listbulkimports
        with:
          X-Pinecone-Api-Version: rest.X-Pinecone-Api-Version
          limit: rest.limit
          paginationToken: rest.paginationToken
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: startbulkimport
        description: Start import
        call: db-data-bulk-operations.startbulkimport
        with:
          X-Pinecone-Api-Version: rest.X-Pinecone-Api-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/bulk/imports/{id}
      name: bulk-imports-id
      description: REST surface for bulk-imports-id.
      operations:
      - method: GET
        name: describebulkimport
        description: Describe an import
        call: db-data-bulk-operations.describebulkimport
        with:
          X-Pinecone-Api-Version: rest.X-Pinecone-Api-Version
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelbulkimport
        description: Cancel an import
        call: db-data-bulk-operations.cancelbulkimport
        with:
          X-Pinecone-Api-Version: rest.X-Pinecone-Api-Version
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: db-data-bulk-operations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Pinecone Data Plane API — Bulk Operations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-imports
      description: List imports
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: db-data-bulk-operations.listbulkimports
      with:
        X-Pinecone-Api-Version: tools.X-Pinecone-Api-Version
        limit: tools.limit
        paginationToken: tools.paginationToken
      outputParameters:
      - type: object
        mapping: $.
    - name: start-import
      description: Start import
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: db-data-bulk-operations.startbulkimport
      with:
        X-Pinecone-Api-Version: tools.X-Pinecone-Api-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: describe-import
      description: Describe an import
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: db-data-bulk-operations.describebulkimport
      with:
        X-Pinecone-Api-Version: tools.X-Pinecone-Api-Version
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-import
      description: Cancel an import
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: db-data-bulk-operations.cancelbulkimport
      with:
        X-Pinecone-Api-Version: tools.X-Pinecone-Api-Version
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.