Get Document List

All API documentation for the Ace Data Cloud platform can be accessed through this interface. The documents are organized in a tree structure, where each document can have a parent document and child documents.

This interface does not require authentication.

Interface Description

  • Request Method: GET
  • Request URL: https://platform.acedata.cloud/api/v1/documents/
  • Request Headers:
    • accept: application/json

Query Parameters

Parameter Type Required Description
id string No Document ID (UUID), supports multiple
type string No Document type: Api, Proxy, Integration, Dataset, Text
private boolean No Whether it is a private document
tag string No Filter by tag
limit integer No Number of items returned per page
offset integer No Offset

CURL Request Example

curl -X GET \
  -H "accept: application/json" \
  "https://platform.acedata.cloud/api/v1/documents/"

Filter by type:

curl -X GET \
  -H "accept: application/json" \
  "https://platform.acedata.cloud/api/v1/documents/?type=Api"

Response Example

{
  "count": 200,
  "results": [
    {
      "id": "doc-uuid",
      "alias": "midjourney-imagine",
      "title": "Midjourney Imagine API",
      "type": "Api",
      "content": "## Interface Description\n\n...",
      "rank": 10,
      "private": false,
      "api_id": "api-uuid",
      "proxy_id": null,
      "dataset_id": null,
      "integration_id": null,
      "parent_id": "parent-uuid",
      "sibling_id": null,
      "tags": ["image", "ai"],
      "metadata": {},
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-08-01T00:00:00.000000Z"
    }
  ]
}

Response Field Description

Field Type Description
id string Unique document identifier (UUID)
alias string Document alias (URL-friendly identifier), used for page routing
title string Document title (may contain $t() translation tags)
type string Document type
content string Document content (Markdown format, may contain $t() translation tags)
rank integer Sorting priority
private boolean Whether it is a private document
api_id string Associated API ID (for Api type documents)
proxy_id string Associated Proxy ID
dataset_id string Associated Dataset ID
integration_id string Associated Integration ID
parent_id string Parent document ID
sibling_id string Sibling document ID

Document Type Description

Type Description
Api API endpoint documentation, associated with a specific API (includes OpenAPI definition)
Proxy Proxy service documentation
Integration Integration documentation
Dataset Dataset documentation
Text Plain text documentation (tutorials, guides, etc.)

Code Example

Python:

import requests

url = "https://platform.acedata.cloud/api/v1/documents/"
headers = {"accept": "application/json"}

response = requests.get(url, headers=headers)
data = response.json()

for doc in data["results"]:
    print(f"Document: {doc['title']} ({doc['alias']})")
    print(f"  Type: {doc['type']}")
    print(f"  URL: https://platform.acedata.cloud/documents/{doc['alias']}")
    print()