v1

latestOpenAPI 3.0.0Apache 2.02026-08-0610023171.4 KB
Formatted Documents

Get formatted text markup

Return stored formatted markup for a checked formatted text, including rendered HTML, the parsed map JSON, and the plain text used for the report.

The text must exist, must not be deleted, must be readable by the authenticated user, and must have formatted report assets available. Non-formatted texts and missing markup/map/plain-text assets return a validation error.

get/api/v2/text/markup/{id}/

Path parameters

idinteger required

Numeric ID of a text check or AI check, depending on the endpoint.

Response

The request succeeded and returned stored formatted markup assets.

successboolean

Example response

{
  "success": true,
  "data": {
    "html": "<p>Example text</p>",
    "map": {
      "success": true
    },
    "text": "Example text"
  }
}