Xceptor Document Upload API — Documents

naftiko: 1.0.0-alpha2
info:
  label: Xceptor Document Upload API — Documents
  description: 'Xceptor Document Upload API — Documents. 6 operations. Lead operation: Xceptor List documents. Self-contained
    Naftiko capability covering one Xceptor business surface.'
  tags:
  - Xceptor
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    XCEPTOR_API_KEY: XCEPTOR_API_KEY
capability:
  consumes:
  - type: http
    namespace: document-upload-documents
    baseUri: https://api.xceptor.com/v1
    description: Xceptor Document Upload API — Documents business capability. Self-contained, no shared references.
    resources:
    - name: documents
      path: /documents
      operations:
      - name: listdocuments
        method: GET
        description: Xceptor List documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter documents by processing status
        - name: classification
          in: query
          type: string
          description: Filter documents by their classified document type
        - name: uploaded_after
          in: query
          type: string
          description: Filter documents uploaded after this date-time
        - name: uploaded_before
          in: query
          type: string
          description: Filter documents uploaded before this date-time
      - name: uploaddocument
        method: POST
        description: Xceptor Upload a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: documents-batch
      path: /documents/batch
      operations:
      - name: uploaddocumentbatch
        method: POST
        description: Xceptor Upload a batch of documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: documents-documentId
      path: /documents/{documentId}
      operations:
      - name: getdocument
        method: GET
        description: Xceptor Get document details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedocument
        method: DELETE
        description: Xceptor Delete a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents-documentId-download
      path: /documents/{documentId}/download
      operations:
      - name: downloaddocument
        method: GET
        description: Xceptor Download original document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.XCEPTOR_API_KEY}}'
  exposes:
  - type: rest
    namespace: document-upload-documents-rest
    port: 8080
    description: REST adapter for Xceptor Document Upload API — Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/documents
      name: documents
      description: REST surface for documents.
      operations:
      - method: GET
        name: listdocuments
        description: Xceptor List documents
        call: document-upload-documents.listdocuments
        with:
          status: rest.status
          classification: rest.classification
          uploaded_after: rest.uploaded_after
          uploaded_before: rest.uploaded_before
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: uploaddocument
        description: Xceptor Upload a document
        call: document-upload-documents.uploaddocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/batch
      name: documents-batch
      description: REST surface for documents-batch.
      operations:
      - method: POST
        name: uploaddocumentbatch
        description: Xceptor Upload a batch of documents
        call: document-upload-documents.uploaddocumentbatch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{documentid}
      name: documents-documentid
      description: REST surface for documents-documentId.
      operations:
      - method: GET
        name: getdocument
        description: Xceptor Get document details
        call: document-upload-documents.getdocument
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedocument
        description: Xceptor Delete a document
        call: document-upload-documents.deletedocument
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{documentid}/download
      name: documents-documentid-download
      description: REST surface for documents-documentId-download.
      operations:
      - method: GET
        name: downloaddocument
        description: Xceptor Download original document
        call: document-upload-documents.downloaddocument
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: document-upload-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Xceptor Document Upload API — Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: xceptor-list-documents
      description: Xceptor List documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: document-upload-documents.listdocuments
      with:
        status: tools.status
        classification: tools.classification
        uploaded_after: tools.uploaded_after
        uploaded_before: tools.uploaded_before
      outputParameters:
      - type: object
        mapping: $.
    - name: xceptor-upload-document
      description: Xceptor Upload a document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: document-upload-documents.uploaddocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: xceptor-upload-batch-documents
      description: Xceptor Upload a batch of documents
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: document-upload-documents.uploaddocumentbatch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: xceptor-get-document-details
      description: Xceptor Get document details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: document-upload-documents.getdocument
      outputParameters:
      - type: object
        mapping: $.
    - name: xceptor-delete-document
      description: Xceptor Delete a document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: document-upload-documents.deletedocument
      outputParameters:
      - type: object
        mapping: $.
    - name: xceptor-download-original-document
      description: Xceptor Download original document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: document-upload-documents.downloaddocument
      outputParameters:
      - type: object
        mapping: $.