ReadMe · Example Payload

Readme Create Guide Example

DocumentationDeveloper HubAPI ReferencePortalsAnalyticsAIMCPBi-Directional Sync

Readme Create Guide Example is an example object payload from ReadMe, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponse

Example Payload

Raw ↑ 
{
  "request": {
    "method": "POST",
    "url": "https://api.readme.com/v2/branches/stable/guides",
    "headers": {
      "Authorization": "Bearer rdme_xxx",
      "Content-Type": "application/json"
    },
    "body": {
      "title": "Quickstart",
      "slug": "quickstart",
      "category": "getting-started",
      "body": "# Quickstart\n\nGet up and running with the API in five minutes.",
      "hidden": false
    }
  },
  "response": {
    "status": 201,
    "body": {
      "slug": "quickstart",
      "title": "Quickstart",
      "category": "getting-started",
      "branch": "stable",
      "hidden": false,
      "createdAt": "2026-05-22T16:01:00Z",
      "updatedAt": "2026-05-22T16:01:00Z"
    }
  }
}