QuickNode Streams REST API — Streams

naftiko: 1.0.0-alpha2
info:
  label: QuickNode Streams REST API — Streams
  description: 'QuickNode Streams REST API — Streams. 6 operations. Lead operation: List Streams. Self-contained Naftiko capability
    covering one Quicknode business surface.'
  tags:
  - Quicknode
  - Streams
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    QUICKNODE_API_KEY: QUICKNODE_API_KEY
capability:
  consumes:
  - type: http
    namespace: streams-streams
    baseUri: https://api.quicknode.com/streams/rest/v1
    description: QuickNode Streams REST API — Streams business capability. Self-contained, no shared references.
    resources:
    - name: streams
      path: /streams
      operations:
      - name: liststreams
        method: GET
        description: List Streams
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createstream
        method: POST
        description: Create a Stream
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: streams-streamId
      path: /streams/{streamId}
      operations:
      - name: getstream
        method: GET
        description: Get Stream details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: streamId
          in: path
          type: string
          required: true
      - name: deletestream
        method: DELETE
        description: Delete a Stream
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: streamId
          in: path
          type: string
          required: true
    - name: streams-streamId-pause
      path: /streams/{streamId}/pause
      operations:
      - name: pausestream
        method: POST
        description: Pause a Stream
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: streamId
          in: path
          type: string
          required: true
    - name: streams-streamId-resume
      path: /streams/{streamId}/resume
      operations:
      - name: resumestream
        method: POST
        description: Resume a Stream
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: streamId
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: x-api-key
      value: '{{env.QUICKNODE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: streams-streams-rest
    port: 8080
    description: REST adapter for QuickNode Streams REST API — Streams. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/streams
      name: streams
      description: REST surface for streams.
      operations:
      - method: GET
        name: liststreams
        description: List Streams
        call: streams-streams.liststreams
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createstream
        description: Create a Stream
        call: streams-streams.createstream
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/streams/{streamid}
      name: streams-streamid
      description: REST surface for streams-streamId.
      operations:
      - method: GET
        name: getstream
        description: Get Stream details
        call: streams-streams.getstream
        with:
          streamId: rest.streamId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletestream
        description: Delete a Stream
        call: streams-streams.deletestream
        with:
          streamId: rest.streamId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/streams/{streamid}/pause
      name: streams-streamid-pause
      description: REST surface for streams-streamId-pause.
      operations:
      - method: POST
        name: pausestream
        description: Pause a Stream
        call: streams-streams.pausestream
        with:
          streamId: rest.streamId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/streams/{streamid}/resume
      name: streams-streamid-resume
      description: REST surface for streams-streamId-resume.
      operations:
      - method: POST
        name: resumestream
        description: Resume a Stream
        call: streams-streams.resumestream
        with:
          streamId: rest.streamId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: streams-streams-mcp
    port: 9090
    transport: http
    description: MCP adapter for QuickNode Streams REST API — Streams. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-streams
      description: List Streams
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: streams-streams.liststreams
      outputParameters:
      - type: object
        mapping: $.
    - name: create-stream
      description: Create a Stream
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: streams-streams.createstream
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-stream-details
      description: Get Stream details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: streams-streams.getstream
      with:
        streamId: tools.streamId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-stream
      description: Delete a Stream
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: streams-streams.deletestream
      with:
        streamId: tools.streamId
      outputParameters:
      - type: object
        mapping: $.
    - name: pause-stream
      description: Pause a Stream
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: streams-streams.pausestream
      with:
        streamId: tools.streamId
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-stream
      description: Resume a Stream
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: streams-streams.resumestream
      with:
        streamId: tools.streamId
      outputParameters:
      - type: object
        mapping: $.