Litmus Instant API — Previews

naftiko: 1.0.0-alpha2
info:
  label: Litmus Instant API — Previews
  description: 'Litmus Instant API — Previews. 3 operations. Lead operation: Litmus Create an email preview. Self-contained
    Naftiko capability covering one Litmus business surface.'
  tags:
  - Litmus
  - Previews
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LITMUS_API_KEY: LITMUS_API_KEY
capability:
  consumes:
  - type: http
    namespace: instant-previews
    baseUri: https://instant-api.litmus.com/v1
    description: Litmus Instant API — Previews business capability. Self-contained, no shared references.
    resources:
    - name: emails
      path: /emails
      operations:
      - name: createemailpreview
        method: POST
        description: Litmus Create an email preview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: emails-emailGuid
      path: /emails/{emailGuid}
      operations:
      - name: getemailpreview
        method: GET
        description: Litmus Get email preview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: emails-emailGuid-previews-clientId
      path: /emails/{emailGuid}/previews/{clientId}
      operations:
      - name: getclientpreview
        method: GET
        description: Litmus Get client preview screenshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.LITMUS_API_KEY}}'
  exposes:
  - type: rest
    namespace: instant-previews-rest
    port: 8080
    description: REST adapter for Litmus Instant API — Previews. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/emails
      name: emails
      description: REST surface for emails.
      operations:
      - method: POST
        name: createemailpreview
        description: Litmus Create an email preview
        call: instant-previews.createemailpreview
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/emails/{emailguid}
      name: emails-emailguid
      description: REST surface for emails-emailGuid.
      operations:
      - method: GET
        name: getemailpreview
        description: Litmus Get email preview
        call: instant-previews.getemailpreview
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/emails/{emailguid}/previews/{clientid}
      name: emails-emailguid-previews-clientid
      description: REST surface for emails-emailGuid-previews-clientId.
      operations:
      - method: GET
        name: getclientpreview
        description: Litmus Get client preview screenshot
        call: instant-previews.getclientpreview
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: instant-previews-mcp
    port: 9090
    transport: http
    description: MCP adapter for Litmus Instant API — Previews. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: litmus-create-email-preview
      description: Litmus Create an email preview
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: instant-previews.createemailpreview
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-email-preview
      description: Litmus Get email preview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: instant-previews.getemailpreview
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-client-preview-screenshot
      description: Litmus Get client preview screenshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: instant-previews.getclientpreview
      outputParameters:
      - type: object
        mapping: $.