하입덕 API 레퍼런스

하입덕 API 레퍼런스

바이럴 인스타그램 릴스를 수집·분석해 광고 대본으로 만드는 공개 REST API입니다. 기본 주소는 https://api.hypeduck.ai 이고, 현재 버전 v1에 엔드포인트 16개가 있습니다.

인증: 발급받은 hd_live_… 키를 Authorization: Bearer 헤더로 보냅니다. 키는 대시보드 설정에서 발급합니다.
응답 봉투: 성공은 { "data": … }, 실패는 { "error": { "code", "message" } } 형태로 옵니다. 성공·실패 모두 같은 껍데기라 분기 하나로 처리됩니다.
쿼터: 하루 사용량이 플랜별로 제한되고 자정(KST)에 리셋됩니다. 무거운 작업(직접 수집·분석 시작·레퍼런스 소싱·영상 변환)은 5콜, 나머지는 1콜로 빠집니다. 남은 양은 응답 헤더 X-Quota-Remaining 으로 확인합니다.

엔드포인트

내 계정

내 정보·플랜·쿼터·등록한 인스타그램 계정·수집 KPI를 읽습니다.

GET/api/v1/me내 정보 조회
GET/api/v1/accounts등록한 인스타그램 계정 목록
GET/api/v1/stats/overview수집 현황 KPI

릴스

수집한 릴스를 조회하고, 메타데이터를 배치로 저장하거나 영상을 직접 넣습니다.

GET/api/v1/reels수집한 릴스 목록 조회
POST/api/v1/reels릴스 메타데이터 배치 저장(upsert)
GET/api/v1/reels/{code}릴스 단건 조회
POST/api/v1/reels/import영상 직접 수집 (URL 또는 업로드)

분석

릴스 AI 분석 작업을 큐에 넣고 진행 상태와 결과를 받습니다.

GET/api/v1/analyses분석 작업 목록 조회
POST/api/v1/analyses릴스 분석 시작
GET/api/v1/analyses/{id}분석 작업 단건 조회 (결과 포함)

대본

분석 결과로 만든 광고 대본의 리비전을 읽고 AI 챗으로 고칩니다.

GET/api/v1/analyses/{id}/scripts/{strategyId}/revisions대본 리비전 목록
POST/api/v1/analyses/{id}/scripts/{strategyId}/chat대본 AI 챗 수정

소싱

레퍼런스 영상·상품을 찾고, 영상 페이지 URL을 재생 가능한 mp4로 바꾸고, 키워드를 번역합니다.

POST/api/v1/sourcing/discover레퍼런스 영상/상품 소싱
POST/api/v1/sourcing/resolve-video영상 페이지 URL → 재생 가능한 mp4 URL
POST/api/v1/sourcing/translate소싱 키워드 번역

문서

이 페이지가 읽어 오는 OpenAPI 스펙 원본입니다.

GET/api/v1/openapi.jsonOpenAPI 스펙(이 문서) 조회

인터랙티브 레퍼런스

아래에서 요청·응답 스키마를 펼쳐 보고 그 자리에서 호출해 볼 수 있습니다.