Get AceDataCloud Platform Document Details

Retrieve the complete content of a single document by document ID (UUID) or alias — with the content field (Markdown text) and breadcrumbs (breadcrumb path) in addition to the list interface.

ℹ️ 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/{id_or_alias}
Authentication ❌ Public

⚠️ The URL should not have a trailing slash — /documents/{id} is not /documents/{id}/.

Authentication Description

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

Path Parameters

Parameter Type Required Description
id_or_alias UUID / string ✅ Document ID (UUID format) or alias (e.g., platform-token)

Query Parameters

Parameter Type Required Default Description
lang string No — Explicit language code (zh-CN, en-US, ja, ko...); if not provided, it will negotiate automatically based on the Accept-Language header

Request Examples

cURL

# By alias
curl 'https://platform.acedata.cloud/api/v1/documents/platform-token' \
  -H 'accept: application/json'

# Force English
curl 'https://platform.acedata.cloud/api/v1/documents/platform-token?lang=en-US' \
  -H 'accept: application/json'

Python

import requests

resp = requests.get(
    "https://platform.acedata.cloud/api/v1/documents/platform-token",
    headers={"accept": "application/json", "accept-language": "zh-CN"},
    timeout=10,
)
doc = resp.json()
print(f"# {doc['title']}\n")
print(doc["content"][:500] + "...")

Node.js

const r = await fetch(
  'https://platform.acedata.cloud/api/v1/documents/platform-token'
)
const doc = await r.json()
console.log(doc.title, doc.content.length, 'bytes')

Response Example (HTTP 200)

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

Response Field Description

The meanings of the fields are the same as in the Document List, with additional fields:

Field Type Description
content string Document body (Markdown format, including code blocks, tables, links, etc.)
breadcrumbs array Breadcrumb navigation: path from the root directory to the current document, each containing id/alias/title

Error Handling

HTTP Code Meaning
404 not_found Document does not exist
500 — Trailing slash mistakenly added to the URL, remove it and retry

Practical Tips

  • Use alias instead of id: UUIDs may change when migrating environments.
  • Markdown Rendering: The content in the response is GitHub-style Markdown, including mdx extensions (e.g., :::note tip boxes). It is recommended to use markdown-it + markdown-it-container for parsing on the frontend.
  • Language Switching: You can pass ?lang= or use the Accept-Language header. All 18 language versions are maintained by an internal automatic translation process, which may lag behind the zh-CN/en-US source versions by several hours.