Get AceDataCloud Platform Document List

Returns all developer document entries on the platform, including all pages at https://platform.acedata.cloud/documents/*, including this document itself. Each document contains metadata such as title, alias, type, parent, sorting, etc. Document content is not returned by this interface (to avoid large response bodies); when needed, call Get AceDataCloud Platform Document Details.

Applicable scenarios:

  • Build sidebar navigation tree.
  • Offline generate SDK reference table.
  • Help center search.

ℹ️ This interface belongs to the AceDataCloud Platform Management API, with a unified prefix of https://platform.acedata.cloud/api/v1/.

Interface Overview

Item Content
Method GET
URL https://platform.acedata.cloud/api/v1/documents/
Authentication ❌ Public

Authentication Description

This interface is completely public, no account token or login state is required.

Query Parameters

Parameter Type Required Default Description
alias string No — Document alias (e.g., platform-token, getting-started). Supports multiple values: ?alias=a&alias=b
type string No — Document type: Article / Document / Category
parent_id UUID No — Parent document ID (used to build document tree). Pass null string to view top-level documents
tag string No — Filter by tag
limit integer No 10 Number of items per page, maximum 100
offset integer No 0 Offset
ordering string No rank Sorting field, prefix - for descending order

Request Examples

cURL

# View all platform developer documents
curl 'https://platform.acedata.cloud/api/v1/documents/?alias=platform-token&alias=platform-credential-create' \
  -H 'accept: application/json'

# View all articles under a specific category
curl 'https://platform.acedata.cloud/api/v1/documents/?parent_id=abc12345-...' \
  -H 'accept: application/json'

Python

import requests

resp = requests.get(
    "https://platform.acedata.cloud/api/v1/documents/",
    headers={"accept": "application/json"},
    params={"limit": 100},
    timeout=10,
)
data = resp.json()
print(f"Total {data['count']} documents")
for d in data["items"][:10]:
    print(f"  {d['alias']:40s} {d['title']}")

Node.js

const r = await fetch('https://platform.acedata.cloud/api/v1/documents/?limit=100')
const { count, items } = await r.json()
console.log(`Total ${count} documents`)

Response Example (HTTP 200)

{
  "count": 32,
  "items": [
    {
      "id": "doc-abc123-...",
      "alias": "platform-token",
      "title": "Manage AceDataCloud Platform Account Token",
      "type": "Article",
      "parent_id": "doc-cat-development",
      "rank": 100,
      "tags": ["platform", "auth"],
      "metadata": null,
      "created_at": "2024-06-11T00:41:29.255614Z",
      "updated_at": "2026-04-26T16:12:40.481154Z"
    }
  ]
}

ℹ️ The list interface does not return the content field (document body Markdown) — it is a large field and is only returned in the detail interface.

Response Field Description

Field Type Description
id UUID Document ID
alias string Document alias (short code), the path of https://platform.acedata.cloud/documents/<alias> URL
title string Document title (automatically localized according to Accept-Language)
type string Document type: Article (article) / Document (developer document) / Category (category)
parent_id UUID null
rank integer Sorting weight
tags array Tags
metadata object null
created_at string Creation time
updated_at string Last updated time

Error Handling

HTTP Code Meaning
400 invalid Invalid parameter value

Practical Tips

  • Build Sidebar: Recursively call this interface by parent_id to generate a complete document tree.
  • alias is a stable identifier: UUIDs may change in different environments (preview / production), while aliases are stable and can be hardcoded into the code.
  • The platform-* series listed by this interface: is the set of developer documents you are currently viewing.