Get API List

Through this interface, you can obtain a list of all API endpoints on the Ace Data Cloud platform, including the name, path, OpenAPI definition, pricing rules, and other information for each API.

This interface does not require authentication.

¶ Interface Description

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

¶ Query Parameters

Parameter	Type	Required	Description
`id`	string	No	API ID (UUID), supports multiple: `?id=xxx&id=yyy`
`service_id`	string	No	Filter by service ID
`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/apis/"

¶ Response Example

{
  "count": 80,
  "results": [
    {
      "id": "api-uuid",
      "name": "Midjourney Imagine",
      "title": "Midjourney Imagine",
      "path": "/v1/midjourney/imagine",
      "path2": null,
      "stage": "Production",
      "cost": [...],
      "definition": {
        "openapi": "3.0.1",
        "info": {"title": "Midjourney Imagine API"},
        "paths": {...}
      },
      "visible_models": null,
      "service_id": "service-uuid",
      "document_id": "doc-uuid",
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-08-01T00:00:00.000000Z"
    }
  ]
}

¶ Response Field Description

Field	Type	Description
`id`	string	API unique identifier (UUID)
`name`	string	API name
`title`	string	API title
`path`	string	API path (main path), URL path for invocation
`path2`	string	API alternative path
`stage`	string	Release stage: `Alpha` (internal test) / `Beta` (public test) / `Production` (official)
`cost`	array	Pricing rules, in JsonLogic format
`definition`	object	OpenAPI 3.0 specification definition, including complete request parameters and response format
`visible_models`	array	List of visible models (only valid for LLM type APIs)
`service_id`	string	Associated service ID
`document_id`	string	Associated document ID

¶ Usage of API Path

The path field indicates the invocation path of the API. The complete URL for actual invocation is:

https://api.acedata.cloud{path}

For example, if the path is /v1/midjourney/imagine, the actual invocation URL will be:

https://api.acedata.cloud/v1/midjourney/imagine

¶ Code Example

Python:

import requests

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

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

for api in data["results"]:
    print(f"API: {api['name']}")
    print(f"  Path: {api['path']}")
    print(f"  Stage: {api['stage']}")
    print(f"  Invocation URL: https://api.acedata.cloud{api['path']}")
    print()