Box Sign Requests API — Sign Requests

naftiko: 1.0.0-alpha2
info:
  label: Box Sign Requests API — Sign Requests
  description: 'Box Sign Requests API — Sign Requests. 5 operations. Lead operation: Box List sign requests. Self-contained
    Naftiko capability covering one Box business surface.'
  tags:
  - Box
  - Sign Requests
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: sign-requests-sign-requests
    baseUri: ''
    description: Box Sign Requests API — Sign Requests business capability. Self-contained, no shared references.
    resources:
    - name: sign_requests
      path: /sign_requests
      operations:
      - name: getsignrequests
        method: GET
        description: Box List sign requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
      - name: postsignrequests
        method: POST
        description: Box Create sign request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: sign_requests-sign_request_id
      path: /sign_requests/{sign_request_id}
      operations:
      - name: getsignrequestsid
        method: GET
        description: Box Get sign request by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_request_id
          in: path
          type: string
          description: The ID of the sign request
          required: true
    - name: sign_requests-sign_request_id-cancel
      path: /sign_requests/{sign_request_id}/cancel
      operations:
      - name: postsignrequestsidcancel
        method: POST
        description: Box Cancel sign request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_request_id
          in: path
          type: string
          description: The ID of the sign request
          required: true
    - name: sign_requests-sign_request_id-resend
      path: /sign_requests/{sign_request_id}/resend
      operations:
      - name: postsignrequestsidresend
        method: POST
        description: Box Resend sign request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_request_id
          in: path
          type: string
          description: The ID of the sign request
          required: true
  exposes:
  - type: rest
    namespace: sign-requests-sign-requests-rest
    port: 8080
    description: REST adapter for Box Sign Requests API — Sign Requests. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/sign-requests
      name: sign-requests
      description: REST surface for sign_requests.
      operations:
      - method: GET
        name: getsignrequests
        description: Box List sign requests
        call: sign-requests-sign-requests.getsignrequests
        with:
          marker: rest.marker
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postsignrequests
        description: Box Create sign request
        call: sign-requests-sign-requests.postsignrequests
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sign-requests/{sign-request-id}
      name: sign-requests-sign-request-id
      description: REST surface for sign_requests-sign_request_id.
      operations:
      - method: GET
        name: getsignrequestsid
        description: Box Get sign request by ID
        call: sign-requests-sign-requests.getsignrequestsid
        with:
          sign_request_id: rest.sign_request_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sign-requests/{sign-request-id}/cancel
      name: sign-requests-sign-request-id-cancel
      description: REST surface for sign_requests-sign_request_id-cancel.
      operations:
      - method: POST
        name: postsignrequestsidcancel
        description: Box Cancel sign request
        call: sign-requests-sign-requests.postsignrequestsidcancel
        with:
          sign_request_id: rest.sign_request_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sign-requests/{sign-request-id}/resend
      name: sign-requests-sign-request-id-resend
      description: REST surface for sign_requests-sign_request_id-resend.
      operations:
      - method: POST
        name: postsignrequestsidresend
        description: Box Resend sign request
        call: sign-requests-sign-requests.postsignrequestsidresend
        with:
          sign_request_id: rest.sign_request_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sign-requests-sign-requests-mcp
    port: 9090
    transport: http
    description: MCP adapter for Box Sign Requests API — Sign Requests. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: box-list-sign-requests
      description: Box List sign requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sign-requests-sign-requests.getsignrequests
      with:
        marker: tools.marker
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: box-create-sign-request
      description: Box Create sign request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sign-requests-sign-requests.postsignrequests
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: box-get-sign-request-id
      description: Box Get sign request by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sign-requests-sign-requests.getsignrequestsid
      with:
        sign_request_id: tools.sign_request_id
      outputParameters:
      - type: object
        mapping: $.
    - name: box-cancel-sign-request
      description: Box Cancel sign request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sign-requests-sign-requests.postsignrequestsidcancel
      with:
        sign_request_id: tools.sign_request_id
      outputParameters:
      - type: object
        mapping: $.
    - name: box-resend-sign-request
      description: Box Resend sign request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sign-requests-sign-requests.postsignrequestsidresend
      with:
        sign_request_id: tools.sign_request_id
      outputParameters:
      - type: object
        mapping: $.