Relay App Automation API — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Relay App Automation API — Workflows
  description: 'Relay App Automation API — Workflows. 2 operations. Lead operation: List Workflows. Self-contained Naftiko
    capability covering one Relay App business surface.'
  tags:
  - Relay App
  - Workflows
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RELAY_APP_API_KEY: RELAY_APP_API_KEY
capability:
  consumes:
  - type: http
    namespace: relay-app-workflows
    baseUri: https://api.relay.app/v1
    description: Relay App Automation 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: page
          in: query
          type: integer
          description: Page number for pagination.
        - name: limit
          in: query
          type: integer
          description: Number of results per page.
    - name: workflows-workflowId
      path: /workflows/{workflowId}
      operations:
      - name: getworkflow
        method: GET
        description: Get Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          description: The unique identifier of the workflow.
          required: true
    authentication:
      type: apikey
      key: X-Relay-API-Key
      value: '{{env.RELAY_APP_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: relay-app-workflows-rest
    port: 8080
    description: REST adapter for Relay App Automation 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: relay-app-workflows.listworkflows
        with:
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflows/{workflowid}
      name: workflows-workflowid
      description: REST surface for workflows-workflowId.
      operations:
      - method: GET
        name: getworkflow
        description: Get Workflow
        call: relay-app-workflows.getworkflow
        with:
          workflowId: rest.workflowId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: relay-app-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Relay App Automation 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: relay-app-workflows.listworkflows
      with:
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: get-workflow
      description: Get Workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: relay-app-workflows.getworkflow
      with:
        workflowId: tools.workflowId
      outputParameters:
      - type: object
        mapping: $.