> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# AceDataCloud 플랫폼 API 세부 정보 가져오기

> Platform API guide - Ace Data Cloud

API ID를 통해 단일 API 엔드포인트의 전체 정보를 가져옵니다—[목록 인터페이스](https://platform.acedata.cloud/documents/platform-api-list)보다 `definition`(OpenAPI 3.0 Schema), `service`(소속 서비스 세부 정보) 및 `products`(연결된 제품) 필드가 추가됩니다.

SDK 자동 생성, LLM Agent에 도구 설명 제공, 문서 사이트 동적 렌더링 등의 시나리오에 적합합니다.

> ℹ️ 이 인터페이스는 **AceDataCloud 플랫폼 관리 API**에 속하며, 통합 접두사는 `https://platform.acedata.cloud/api/v1/`입니다. 전체 인터페이스 인덱스는 [AceDataCloud 플랫폼 문서 목록 가져오기](https://platform.acedata.cloud/documents/platform-document-list)를 참조하세요.

## 인터페이스 개요

| 항목 | 내용 |
| - | - |
| 메서드 | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/apis/{api_id}` |
| 인증 | ❌ 공개 |

`/apis/{id}` 및 `/apis/{id}/`는 현재 모두 사용할 수 있으며, 예시는 통일하여 끝 슬래시가 없는 형식을 사용합니다.

## 인증 설명

이 인터페이스는 **완전히 공개되어 있으며 계정 토큰이나 로그인 상태가 필요하지 않습니다**.

## 경로 매개변수

| 매개변수 | 유형 | 필수 | 설명 |
| - | - | - | - |
| `api_id` | UUID | ✅ | API ID(UUID 형식, 별칭 미지원) |

## 요청 예시

### cURL

```shell theme={null}
curl 'https://platform.acedata.cloud/api/v1/apis/afc7917f-d89f-4dc9-95c2-863936b02cad' \
  -H 'accept: application/json'
```

### Python

```python theme={null}
import requests

api_id = "afc7917f-d89f-4dc9-95c2-863936b02cad"
resp = requests.get(
    f"https://platform.acedata.cloud/api/v1/apis/{api_id}",
    headers={"accept": "application/json"},
    timeout=10,
)
api = resp.json()
print(f"API: {api['title']}")
print(f"경로: {api['path']}")
print(f"소속 서비스: {api['service']['title']} ({api['service']['alias']})")
print(f"OpenAPI 경로 수: {len(api.get('definition', {}).get('paths', {}))}")
```

### Node.js

```javascript theme={null}
const apiId = 'afc7917f-d89f-4dc9-95c2-863936b02cad'
const r = await fetch(`https://platform.acedata.cloud/api/v1/apis/${apiId}`)
const api = await r.json()
console.log(api.title, api.path, api.service.title)
```

## 응답 예시(HTTP 200)

```json theme={null}
{
  "id": "afc7917f-d89f-4dc9-95c2-863936b02cad",
  "document_id": "e31b3e50-d91d-4a4f-8d32-8dd8c9e2f512",
  "service_id": "5d732942-4d44-48be-958e-dd8474d8aa8d",
  "name": "ChatDoc Documents API",
  "title": "ChatDoc Documents API",
  "path": "/chatdoc/documents",
  "path2": null,
  "introduction": "지식 저장소를 생성한 후 이 API를 사용하여 지식 저장소에서 문서를 추가, 조회, 수정 또는 삭제할 수 있습니다.",
  "cost": [
    { "conditions": { "==": [1, 1] }, "consumption": 0.057 }
  ],
  "stage": "Beta",
  "rank": 10,
  "tags": [],
  "metadata": null,
  "created_at": "2023-09-03T17:55:48.179195Z",
  "updated_at": "2026-04-26T16:16:35.579082Z",
  "service": {
    "id": "5d732942-4d44-48be-958e-dd8474d8aa8d",
    "title": "ChatDoc 질의응답",
    "type": "Api",
    "alias": "chatdoc"
  },
  "products": [],
  "definition": {
    "openapi": "3.0.0",
    "info": { "title": "ChatDoc Documents API", "version": "0.1" },
    "paths": {
      "/chatdoc/documents": {
        "post": { "...": "..." }
      }
    },
    "components": { "schemas": { "...": "..." } }
  }
}
```

## 응답 필드 설명

세부 정보 인터페이스에는 [목록 인터페이스 필드](https://platform.acedata.cloud/documents/platform-api-list)를 기반으로 다음이 추가로 포함됩니다:

| 필드 | 유형 | 설명 |
| - | - | - |
| `service` | object | 소속 서비스의 핵심 정보: `id`, `title`, `type`, `alias` |
| `products` | array | 연결된 제품 목록(일반적으로 비어 있으며, 운영 측에서 사용) |
| `definition` | object | **완전한 OpenAPI 3.0 사양 정의**이며, `paths`, `components`, `info` 등을 포함하고 `openapi-generator`에 직접 제공하여 클라이언트 코드를 생성할 수 있음 |

## 오류 처리

| HTTP | code | 의미 |
| - | - | - |
| 400 | `invalid` | `api_id`가 유효한 UUID가 아님 |
| 404 | `not_found` | API가 존재하지 않거나 이미 종료됨 |

## 유용한 팁

* **`definition` 필드는 매우 큽니다**: 단일 API의 OpenAPI Schema에는 수백 줄의 JSON이 있을 수 있습니다. 서비스 인덱스만 필요하고 Schema가 필요하지 않다면 [목록 인터페이스](https://platform.acedata.cloud/documents/platform-api-list)를 대신 사용해야 합니다.
* **SDK 생성의 일반적인 사용법**:
  ```shell theme={null}
  # OpenAPI 파일 가져오기
  curl -s 'https://platform.acedata.cloud/api/v1/apis/<api_id>' | jq '.definition' > openapi.json

  # openapi-generator-cli로 Python 클라이언트 생성
  openapi-generator-cli generate -i openapi.json -g python -o ./client
  ```
* **API 변경 추적**: `updated_at` 필드는 schema의 마지막 변경 시간입니다. 이 필드를 구독하면 OpenAPI 변경 시 SDK를 자동으로 다시 생성할 수 있습니다.

## 관련 인터페이스

* [AceDataCloud 플랫폼 API 목록 가져오기](https://platform.acedata.cloud/documents/platform-api-list)
* [AceDataCloud 플랫폼 API 호출 통계 가져오기](https://platform.acedata.cloud/documents/platform-api-usage)
* [AceDataCloud 플랫폼 서비스 세부 정보 가져오기](https://platform.acedata.cloud/documents/platform-service-detail)
* [AceDataCloud 플랫폼 문서 세부 정보 가져오기](https://platform.acedata.cloud/documents/platform-document-detail) — `document_id`를 사용하여 렌더링된 개발자 문서로 이동


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.