v1
In-guide features

Get generated page structure for a guide

Retrieves the generated page structure (flat heading list) for a guide.

get/api/v1/outline

Request

  • Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.serpmantics.com/api/v1/outline
  • Auth: HTTP bearer

Query parameters

guideIdstring required

ID of the guide

Response

Page structure retrieved successfully

successboolean
isReadyboolean

Whether the generation is complete

Example response

{
  "success": true,
  "isReady": true,
  "data": {
    "pageStructure": [
      {
        "hn": 2,
        "text": "Introduction au SEO"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.