Docs Catalog

The Docs Catalog endpoint returns a dynamic list of every current endpoint documentation page, including the public docs link and raw Markdown download link.

Use this when you want your app, bot, CLI, or AI agent to discover available Nabzclan Developer API docs automatically.

[!IMPORTANT] This endpoint requires a Developer API token, but it does not count against normal request usage or AI request usage.

Endpoint

GET https://developer.nabzclan.vip/api/docs/endpoints

Authentication

Include your Developer API token in the Authorization header:

Authorization: Bearer ***

Example Request

curl "https://developer.nabzclan.vip/api/docs/endpoints" \
  -H "Authorization: Bearer ***" \
  -H "Accept: application/json"

Response

{
  "docs": [
    {
      "name": "nabz-search-api",
      "title": "Nabz Search",
      "description": "Search the web, scrape pages, map site URLs, and extract structured data...",
      "docs_page": "https://developer.nabzclan.vip/docs/endpoints/nabz-search",
      "md_download": "https://developer.nabzclan.vip/docs-download/endpoints/nabz-search",
      "endpoints": [
        {
          "method": "GET",
          "path": "/api/nabzsearch/search?query=your+search+query"
        },
        {
          "method": "POST",
          "path": "/api/nabzsearch/scrape"
        }
      ],
      "is_ai": true
    }
  ]
}

Response Fields

Field Type Description
docs array List of current endpoint documentation pages.
name string Machine-friendly API docs name generated from the docs title.
title string Human-readable docs title.
description string Short summary pulled from the docs page.
docs_page string Public HTML documentation URL.
md_download string Raw Markdown download URL for scripts, bots, AI agents, or local docs sync.
endpoints array HTTP methods and paths found in that docs page.
is_ai boolean Whether the docs page appears to describe an AI/request-tracked feature.

Notes

  • The list is generated from the current Markdown files in resources/docs/endpoints.
  • New endpoint docs appear automatically once their Markdown page exists.
  • Requests require an API token but are not logged as normal or AI usage.