ReadMe · Example Payload

Readme Search Example

DocumentationDeveloper HubAPI ReferencePortalsAnalyticsAIMCPBi-Directional Sync

Readme Search 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": "GET",
    "url": "https://api.readme.com/v2/search?q=authentication",
    "headers": {
      "Authorization": "Bearer rdme_xxx"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "results": [
        { "slug": "authentication", "title": "Authentication", "type": "guide" },
        { "slug": "api-keys", "title": "Managing API Keys", "type": "guide" },
        { "slug": "list-api-keys", "title": "List API Keys", "type": "reference" }
      ],
      "total": 3
    }
  }
}