API Reference

Puppetalk API

Puppetalk API를 사용하면 외부 서비스에서 프로젝트를 생성하고 렌더링 상태를 조회할 수 있습니다. 모든 요청은 HTTPS로 전송되며, 발급된 API Key를 Bearer 토큰으로 전달해야 합니다.

인증 방법

모든 API 요청은 Authorization 헤더에 Bearer 토큰을 포함해야 합니다. 발급된 Key는 한 번만 표시되므로 안전한 비밀 저장소에 보관하세요.

Authorization: Bearer pk_live_your_api_key

엔드포인트

아래 엔드포인트를 통해 프로젝트 생성과 상태 추적을 자동화할 수 있습니다.

POST/api/v1/render

새 프로젝트 생성

요청 예시

curl -X POST https://puppetalk.io/api/v1/render \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  --data '{
    "characterId": "chr_a1b2c3d4e5f6",
    "title": "에피소드 1"
  }'

응답 예시

{
  "success": true,
  "data": {
    "projectId": "prj_x1y2z3",
    "message": "프로젝트가 생성되었습니다."
  }
}

GET/api/v1/render/:id/status

프로젝트 상태 조회

요청 예시

curl https://puppetalk.io/api/v1/render/prj_x1y2z3/status \
  -H "Authorization: Bearer pk_live_your_api_key"

응답 예시

{
  "success": true,
  "data": {
    "projectId": "prj_x1y2z3",
    "status": "PROCESSING",
    "progress": 72
  }
}

오류 코드

코드	설명
401	인증 실패
403	크레딧 부족
404	리소스 없음
422	요청 데이터 오류

시작하기

먼저 API Key를 발급한 뒤, 서버 환경 변수나 비밀 저장소에 안전하게 보관하세요.

API Key 발급 페이지로 이동