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

# API 레퍼런스

> Data Hub REST API의 베이스 URL, 인증, 응답 형태, 페이지매김, 오류, 시간, App 참조와 엔드포인트 인덱스.

이 섹션은 Data Hub 공개 REST 엔드포인트를 리소스별로 정리합니다. 각 페이지에는 메서드/경로, 인증, 파라미터, 실제 응답 예시와 필드 설명, 가능 오류, 클라이언트 대응 메서드가 있습니다. 이 페이지는 공통 규약만 다룹니다.

## 베이스 URL

| 항목      | 값                                   |
| ------- | ----------------------------------- |
| 베이스 URL | `https://api-datahub.octoparse.com` |
| 경로 접두사  | 모든 엔드포인트는 `/v1`로 시작                 |
| 프로토콜    | HTTPS, 본문은 JSON                     |

<Note>
  `/v1` 계약은 추가만 합니다. 새 필드/엔드포인트는 생길 수 있지만 이미 공개된 필드의 이름과 의미는 바뀌지 않습니다. 알 수 없는 필드는 무시하세요.
</Note>

## 인증

```http theme={null}
Authorization: Bearer <your API key>
```

API 키는 <a href="https://www.octoparse.com/console/open-platform/api-keys" target="_blank" rel="noopener noreferrer">Octoparse 계정 센터</a>에서 만듭니다.

| 유형       | 의미                                |
| -------- | --------------------------------- |
| 익명       | 자격 증명 불필요                         |
| 선택 인증    | 없어도 호출 가능. 있으면 로그인 필터/추가 콘텐츠      |
| API 키 필요 | 자격 증명 필수                          |
| App 작성자만 | 자격 증명 필수이며 해당 App 게시자만. 그 외 `404` |

<Warning>
  Data Hub API는 `Authorization: Bearer`만 받습니다. 쿼리에 자격 증명을 넣지 마세요. 상단 Octoparse 스크레이퍼 MCP의 `x-api-key`와 다릅니다.
</Warning>

## 응답 형태

성공은 `data`, 오류는 `error`. 동시에 나오지 않습니다.

## 오류

필드: `code`, `category`, `message`, `retryable`, `details`. 공통: `401 unauthorized`, `404 *-not-found`, `400 invalid-input`.

## 페이지매김

목록은 `offset`/`limit`과 `pagination`을 사용합니다. `has_more`이면 `offset`에 `count`를 더하세요.

## 시간 파라미터

ISO 8601과 명시적 오프셋을 권장합니다. Unix epoch 초는 받지 않습니다.

## App 참조

안정 id `app_<hex>`(권장) 또는 `<namespace>/<app_name>`.

## 실행 상태

비종료: `PENDING`, `QUEUED`, `RUNNING`. 종료: `SUCCEEDED`, `PARTIALLY_SUCCEEDED`, `FAILED`, `CANCELLED`, `EXPIRED`.

## 엔드포인트 그룹

<CardGroup cols={2}>
  <Card title="Data App 검색" href="/docs/ko/datahub/api/reference/discovery/search-data-apps">검색, 상세, 버전, README, 스펙, 번역</Card>
  <Card title="실행과 결과" href="/docs/ko/datahub/api/reference/runs/start-run">시작, 조회, 목록, 취소, 레코드, 디버그 추적</Card>
  <Card title="데이터셋" href="/docs/ko/datahub/api/reference/datasets/list-datasets">결과 저장소와 보존 플래그</Card>
  <Card title="계정과 청구" href="/docs/ko/datahub/api/reference/account/get-account">누적 지출과 집계</Card>
  <Card title="시크릿" href="/docs/ko/datahub/api/reference/secrets/list-secrets">작성자용 업스트림 자격 증명</Card>
  <Card title="게시와 운영" href="/docs/ko/datahub/api/reference/publishing/validate-manifest">Draft → Build → Release, 공유, 번역, 분석</Card>
</CardGroup>