Get Knowledge Base Article Content API

Retrieve the content of a Knowledge Base article in a specific language. Content can be returned as either Markdown or HTML.

Endpoint

GET /v1/knowledge-base/articles/{correlationId}/content/{lang}

Path Parameters

Parameter

Type

Required

Description

correlationId

string

Yes

The article identifier. This can be your own correlation ID from import, or the internal Product Fruits article ID prefixed with

pf_

.

lang

string

Yes

The language code for the article content, for example

en

.

Query Parameters

Parameter

Type

Required

Default

Description

format

string

No

markdown

Determines the response content format. Supported values are

markdown

and

html

.

Format Behavior

Knowledge Base articles are originally imported into Product Fruits as Markdown.

However, after a user edits and saves an article in the Product Fruits editor, HTML becomes the canonical source of the article content. This can affect how Markdown responses are generated.

format=html

Returns the current canonical HTML content. Use this format when you need the most accurate representation of the article as it currently exists in Product Fruits.

format=markdown

Returns Markdown content.

Behavior depends on whether the article has been edited after import:

  • If the article has not been edited since import, the original Markdown is returned unchanged.
  • If the article has been edited, the current HTML content is converted back to Markdown.

Because some HTML elements do not have a direct Markdown equivalent, converted Markdown responses may include a conversionResults array. This array describes any elements that were dropped, simplified, or changed during conversion.

Examples of possible conversion limitations include:

  • iframe embeds
  • video embeds
  • custom HTML blocks
  • table styling
  • code-block language hints

conversionResults is empty when:

  • format=html is used, or
  • the original Markdown is returned unchanged.

Example Request

GET /v1/knowledge-base/articles/rich-md-fixture/content/en?format=markdown

Example Response

{
"articleId": 5876,
"articleCorrelationId": "rich-md-fixture",
"contentId": 12044,
"contentCorrelationId": "...",
"lang": "en",
"title": "...",
"slug": "...",
"keywords": "...",
"lead": "...",
"published": true,
"lastModified": "2026-05-25T10:14:00Z",
"format": "markdown",
"content": "# ...",
"conversionResults": [
{
"type": "dropped",
"element": "iframe",
"count": 1,
"message": "YouTube video embed dropped"
}
]
}

Response Fields

Field

Type

Description

articleId

number

Internal Product Fruits article ID.

articleCorrelationId

string

Article correlation ID. This may be your imported correlation ID or an internal Product Fruits identifier.

contentId

number

Internal ID of the article content version/language entry.

contentCorrelationId

string

Correlation ID of the content entry.

lang

string

Language code of the returned content.

title

string

Article title.

slug

string

Article URL slug.

keywords

string

Article keywords.

lead

string

Article lead or short description.

published

boolean

Indicates whether the article content is published.

lastModified

string

Timestamp of the last modification in ISO 8601 format.

format

string

Format of the returned content, either

markdown

or

html

.

content

string

Article content in the requested format.

conversionResults

array

List of conversion notes. Empty when no conversion issues occurred.

Conversion Result Object

When Markdown is requested for an article that has been edited in the Product Fruits editor, the API may convert the current HTML back to Markdown. Any lossy or simplified conversions are listed in conversionResults.

Field

Type

Description

type

string

Type of conversion result, for example

dropped

or

simplified

.

element

string

HTML element affected by the conversion.

count

number

Number of affected elements.

message

string

Human-readable explanation of the conversion result.

Error Responses

Status Code

Description

400

Missing

correlationId

or

lang

.

401

Missing or invalid authentication token.

404

Article not found, or content for the requested language does not exist.

Notes

For the most accurate content representation, use format=html.

Use format=markdown when you need Markdown output, but check conversionResults to detect whether any HTML elements were lost or simplified during conversion.