Box Workflows API — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Box Workflows API — Workflows
  description: 'Box Workflows API — Workflows. 2 operations. Lead operation: Box List workflows. Self-contained Naftiko capability
    covering one Box business surface.'
  tags:
  - Box
  - Workflows
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: workflows-workflows
    baseUri: ''
    description: Box Workflows API — Workflows business capability. Self-contained, no shared references.
    resources:
    - name: workflows
      path: /workflows
      operations:
      - name: getworkflows
        method: GET
        description: Box List workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: folder_id
          in: query
          type: string
          description: The unique identifier that represent a folder.
          required: true
        - name: trigger_type
          in: query
          type: string
          description: Type of trigger to search for.
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
    - name: workflows-workflow_id-start
      path: /workflows/{workflow_id}/start
      operations:
      - name: postworkflowsidstart
        method: POST
        description: Box Starts workflow based on request body
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflow_id
          in: path
          type: string
          description: The ID of the workflow.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: workflows-workflows-rest
    port: 8080
    description: REST adapter for Box Workflows API — Workflows. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/workflows
      name: workflows
      description: REST surface for workflows.
      operations:
      - method: GET
        name: getworkflows
        description: Box List workflows
        call: workflows-workflows.getworkflows
        with:
          folder_id: rest.folder_id
          trigger_type: rest.trigger_type
          limit: rest.limit
          marker: rest.marker
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflows/{workflow-id}/start
      name: workflows-workflow-id-start
      description: REST surface for workflows-workflow_id-start.
      operations:
      - method: POST
        name: postworkflowsidstart
        description: Box Starts workflow based on request body
        call: workflows-workflows.postworkflowsidstart
        with:
          workflow_id: rest.workflow_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: workflows-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Box Workflows API — Workflows. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: box-list-workflows
      description: Box List workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workflows-workflows.getworkflows
      with:
        folder_id: tools.folder_id
        trigger_type: tools.trigger_type
        limit: tools.limit
        marker: tools.marker
      outputParameters:
      - type: object
        mapping: $.
    - name: box-starts-workflow-based-request
      description: Box Starts workflow based on request body
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflows-workflows.postworkflowsidstart
      with:
        workflow_id: tools.workflow_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.