Escape Public API — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Escape Public API — Workflows
  description: 'Escape Public API — Workflows. 5 operations. Lead operation: List workflows.. Self-contained Naftiko capability
    covering one Escape business surface.'
  tags:
  - Escape
  - Workflows
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ESCAPE_API_KEY: ESCAPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: escape-workflows
    baseUri: https://public.escape.tech/v3
    description: Escape Public API — Workflows business capability. Self-contained, no shared references.
    resources:
    - name: workflows
      path: /workflows
      operations:
      - name: listworkflows
        method: GET
        description: List workflows.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cursor
          in: query
          type: string
          description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the
            first page will be returned.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: workflowIds
          in: query
          type: array
          description: Filter by workflow IDs
        - name: projectIds
          in: query
          type: array
          description: Filter by project IDs
        - name: integrationIds
          in: query
          type: array
          description: Filter by integration IDs
        - name: triggers
          in: query
          type: array
          description: Filter by triggers
        - name: search
          in: query
          type: string
          description: Search term to filter integrations by name or description
      - name: createworkflow
        method: POST
        description: Create workflows.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: workflows-id
      path: /workflows/{id}
      operations:
      - name: getworkflow
        method: GET
        description: Get workflow.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The workflow ID
          required: true
      - name: updateworkflow
        method: PUT
        description: Update workflow.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The workflow ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteworkflow
        method: DELETE
        description: Delete workflow.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The workflow ID
          required: true
    authentication:
      type: apikey
      key: X-ESCAPE-API-KEY
      value: '{{env.ESCAPE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: escape-workflows-rest
    port: 8080
    description: REST adapter for Escape Public 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: listworkflows
        description: List workflows.
        call: escape-workflows.listworkflows
        with:
          cursor: rest.cursor
          size: rest.size
          sortType: rest.sortType
          sortDirection: rest.sortDirection
          workflowIds: rest.workflowIds
          projectIds: rest.projectIds
          integrationIds: rest.integrationIds
          triggers: rest.triggers
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createworkflow
        description: Create workflows.
        call: escape-workflows.createworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflows/{id}
      name: workflows-id
      description: REST surface for workflows-id.
      operations:
      - method: GET
        name: getworkflow
        description: Get workflow.
        call: escape-workflows.getworkflow
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateworkflow
        description: Update workflow.
        call: escape-workflows.updateworkflow
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteworkflow
        description: Delete workflow.
        call: escape-workflows.deleteworkflow
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: escape-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Escape Public API — Workflows. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-workflows
      description: List workflows.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: escape-workflows.listworkflows
      with:
        cursor: tools.cursor
        size: tools.size
        sortType: tools.sortType
        sortDirection: tools.sortDirection
        workflowIds: tools.workflowIds
        projectIds: tools.projectIds
        integrationIds: tools.integrationIds
        triggers: tools.triggers
        search: tools.search
      outputParameters:
      - type: object
        mapping: $.
    - name: create-workflows
      description: Create workflows.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: escape-workflows.createworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-workflow
      description: Get workflow.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: escape-workflows.getworkflow
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-workflow
      description: Update workflow.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: escape-workflows.updateworkflow
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-workflow
      description: Delete workflow.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: escape-workflows.deleteworkflow
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.