Salesforce Flow REST API — Flow Interviews

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Flow REST API — Flow Interviews
  description: 'Salesforce Flow REST API — Flow Interviews. 3 operations. Lead operation: Create Flow Interview. Self-contained
    Naftiko capability covering one Salesforce Flow business surface.'
  tags:
  - Salesforce Flow
  - Flow Interviews
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_FLOW_API_KEY: SALESFORCE_FLOW_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-flow-interviews
    baseUri: https://{instance}.salesforce.com/services/data/v59.0
    description: Salesforce Flow REST API — Flow Interviews business capability. Self-contained, no shared references.
    resources:
    - name: sobjects-FlowInterview
      path: /sobjects/FlowInterview
      operations:
      - name: createflowinterview
        method: POST
        description: Create Flow Interview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sobjects-FlowInterview-interviewId
      path: /sobjects/FlowInterview/{interviewId}
      operations:
      - name: getflowinterview
        method: GET
        description: Get Flow Interview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: interviewId
          in: path
          type: string
          description: The unique Salesforce ID of the FlowInterview record
          required: true
      - name: deleteflowinterview
        method: DELETE
        description: Delete Flow Interview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: interviewId
          in: path
          type: string
          description: The unique Salesforce ID of the FlowInterview record
          required: true
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_FLOW_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-flow-interviews-rest
    port: 8080
    description: REST adapter for Salesforce Flow REST API — Flow Interviews. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/sobjects/flowinterview
      name: sobjects-flowinterview
      description: REST surface for sobjects-FlowInterview.
      operations:
      - method: POST
        name: createflowinterview
        description: Create Flow Interview
        call: rest-flow-interviews.createflowinterview
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sobjects/flowinterview/{interviewid}
      name: sobjects-flowinterview-interviewid
      description: REST surface for sobjects-FlowInterview-interviewId.
      operations:
      - method: GET
        name: getflowinterview
        description: Get Flow Interview
        call: rest-flow-interviews.getflowinterview
        with:
          interviewId: rest.interviewId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteflowinterview
        description: Delete Flow Interview
        call: rest-flow-interviews.deleteflowinterview
        with:
          interviewId: rest.interviewId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-flow-interviews-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Flow REST API — Flow Interviews. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-flow-interview
      description: Create Flow Interview
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-flow-interviews.createflowinterview
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-interview
      description: Get Flow Interview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-flow-interviews.getflowinterview
      with:
        interviewId: tools.interviewId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-flow-interview
      description: Delete Flow Interview
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-flow-interviews.deleteflowinterview
      with:
        interviewId: tools.interviewId
      outputParameters:
      - type: object
        mapping: $.