Core API — Knowledge Base Articles

naftiko: 1.0.0-alpha2
info:
  label: Core API — Knowledge Base Articles
  description: 'Core API — Knowledge Base Articles. 9 operations. Lead operation: Get a knowledge base article. Self-contained
    Naftiko capability covering one Front business surface.'
  tags:
  - Front
  - Knowledge Base Articles
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRONT_API_KEY: FRONT_API_KEY
capability:
  consumes:
  - type: http
    namespace: core-knowledge-base-articles
    baseUri: https://api2.frontapp.com
    description: Core API — Knowledge Base Articles business capability. Self-contained, no shared references.
    resources:
    - name: knowledge_base_articles-article_id
      path: /knowledge_base_articles/{article_id}
      operations:
      - name: getaknowledgebasearticle
        method: GET
        description: Get a knowledge base article
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article to fetch
          required: true
      - name: deleteanarticle
        method: DELETE
        description: Delete an article
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article to delete
          required: true
    - name: knowledge_base_articles-article_id-content
      path: /knowledge_base_articles/{article_id}/content
      operations:
      - name: getknowledgebasearticlewithcontentindefaultlocale
        method: GET
        description: Get knowledge base article with content in default locale
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article to fetch
          required: true
      - name: updatearticlecontentindefaultlocale
        method: PATCH
        description: Update article content in default locale.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article to update
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: knowledge_base_articles-article_id-download-attachment_id
      path: /knowledge_base_articles/{article_id}/download/{attachment_id}
      operations:
      - name: downloadattachmentfromanarticle
        method: GET
        description: Download attachment from an article
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article
          required: true
        - name: attachment_id
          in: path
          type: string
          description: The ID of the file to download
          required: true
    - name: knowledge_base_articles-article_id-locales-locale-content
      path: /knowledge_base_articles/{article_id}/locales/{locale}/content
      operations:
      - name: getknowledgebasearticlewithcontentinspecifiedlocale
        method: GET
        description: Get knowledge base article with content in specified locale
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article to fetch
          required: true
        - name: locale
          in: path
          type: string
          description: The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch
          required: true
      - name: updatearticlecontentinspecifiedlocale
        method: PATCH
        description: Update article content in specified locale
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: article_id
          in: path
          type: string
          description: The ID of the article to update
          required: true
        - name: locale
          in: path
          type: string
          description: The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: knowledge_base_categories-category_id-articles
      path: /knowledge_base_categories/{category_id}/articles
      operations:
      - name: listarticlesinacategory
        method: GET
        description: List articles in a category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: category_id
          in: path
          type: string
          description: The ID of the category
          required: true
    - name: knowledge_bases-knowledge_base_id-articles
      path: /knowledge_bases/{knowledge_base_id}/articles
      operations:
      - name: listarticlesinaknowledgebase
        method: GET
        description: List articles in a knowledge base
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: knowledge_base_id
          in: path
          type: string
          description: The ID of the knowledge base
          required: true
    authentication:
      type: bearer
      token: '{{env.FRONT_API_KEY}}'
  exposes:
  - type: rest
    namespace: core-knowledge-base-articles-rest
    port: 8080
    description: REST adapter for Core API — Knowledge Base Articles. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/knowledge-base-articles/{article-id}
      name: knowledge-base-articles-article-id
      description: REST surface for knowledge_base_articles-article_id.
      operations:
      - method: GET
        name: getaknowledgebasearticle
        description: Get a knowledge base article
        call: core-knowledge-base-articles.getaknowledgebasearticle
        with:
          article_id: rest.article_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteanarticle
        description: Delete an article
        call: core-knowledge-base-articles.deleteanarticle
        with:
          article_id: rest.article_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/knowledge-base-articles/{article-id}/content
      name: knowledge-base-articles-article-id-content
      description: REST surface for knowledge_base_articles-article_id-content.
      operations:
      - method: GET
        name: getknowledgebasearticlewithcontentindefaultlocale
        description: Get knowledge base article with content in default locale
        call: core-knowledge-base-articles.getknowledgebasearticlewithcontentindefaultlocale
        with:
          article_id: rest.article_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatearticlecontentindefaultlocale
        description: Update article content in default locale.
        call: core-knowledge-base-articles.updatearticlecontentindefaultlocale
        with:
          article_id: rest.article_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/knowledge-base-articles/{article-id}/download/{attachment-id}
      name: knowledge-base-articles-article-id-download-attachment-id
      description: REST surface for knowledge_base_articles-article_id-download-attachment_id.
      operations:
      - method: GET
        name: downloadattachmentfromanarticle
        description: Download attachment from an article
        call: core-knowledge-base-articles.downloadattachmentfromanarticle
        with:
          article_id: rest.article_id
          attachment_id: rest.attachment_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/knowledge-base-articles/{article-id}/locales/{locale}/content
      name: knowledge-base-articles-article-id-locales-locale-content
      description: REST surface for knowledge_base_articles-article_id-locales-locale-content.
      operations:
      - method: GET
        name: getknowledgebasearticlewithcontentinspecifiedlocale
        description: Get knowledge base article with content in specified locale
        call: core-knowledge-base-articles.getknowledgebasearticlewithcontentinspecifiedlocale
        with:
          article_id: rest.article_id
          locale: rest.locale
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatearticlecontentinspecifiedlocale
        description: Update article content in specified locale
        call: core-knowledge-base-articles.updatearticlecontentinspecifiedlocale
        with:
          article_id: rest.article_id
          locale: rest.locale
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/knowledge-base-categories/{category-id}/articles
      name: knowledge-base-categories-category-id-articles
      description: REST surface for knowledge_base_categories-category_id-articles.
      operations:
      - method: GET
        name: listarticlesinacategory
        description: List articles in a category
        call: core-knowledge-base-articles.listarticlesinacategory
        with:
          category_id: rest.category_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/knowledge-bases/{knowledge-base-id}/articles
      name: knowledge-bases-knowledge-base-id-articles
      description: REST surface for knowledge_bases-knowledge_base_id-articles.
      operations:
      - method: GET
        name: listarticlesinaknowledgebase
        description: List articles in a knowledge base
        call: core-knowledge-base-articles.listarticlesinaknowledgebase
        with:
          knowledge_base_id: rest.knowledge_base_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: core-knowledge-base-articles-mcp
    port: 9090
    transport: http
    description: MCP adapter for Core API — Knowledge Base Articles. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-knowledge-base-article
      description: Get a knowledge base article
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.getaknowledgebasearticle
      with:
        article_id: tools.article_id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-article
      description: Delete an article
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: core-knowledge-base-articles.deleteanarticle
      with:
        article_id: tools.article_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-knowledge-base-article-content
      description: Get knowledge base article with content in default locale
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.getknowledgebasearticlewithcontentindefaultlocale
      with:
        article_id: tools.article_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-article-content-default-locale
      description: Update article content in default locale.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.updatearticlecontentindefaultlocale
      with:
        article_id: tools.article_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: download-attachment-article
      description: Download attachment from an article
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.downloadattachmentfromanarticle
      with:
        article_id: tools.article_id
        attachment_id: tools.attachment_id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-knowledge-base-article-content-2
      description: Get knowledge base article with content in specified locale
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.getknowledgebasearticlewithcontentinspecifiedlocale
      with:
        article_id: tools.article_id
        locale: tools.locale
      outputParameters:
      - type: object
        mapping: $.
    - name: update-article-content-specified-locale
      description: Update article content in specified locale
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.updatearticlecontentinspecifiedlocale
      with:
        article_id: tools.article_id
        locale: tools.locale
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-articles-category
      description: List articles in a category
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.listarticlesinacategory
      with:
        category_id: tools.category_id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-articles-knowledge-base
      description: List articles in a knowledge base
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-knowledge-base-articles.listarticlesinaknowledgebase
      with:
        knowledge_base_id: tools.knowledge_base_id
      outputParameters:
      - type: object
        mapping: $.