apick-api 3.11.0 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +172 -159
- package/LICENSE +21 -21
- package/README.md +461 -463
- package/SECURITY.md +11 -11
- package/docs/guide.en.md +359 -361
- package/docs/guide.ko.md +368 -369
- package/docs/subagent.md +39 -39
- package/docs/tts.md +34 -54
- package/package.json +1 -1
- package/src/index.cjs +58 -50
- package/src/index.d.ts +59 -42
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
# 4.0.1 — 2026-10-06
|
|
2
|
+
|
|
3
|
+
- 이미지 생성·편집에 `quality` 옵션을 추가했습니다: `basic`(기본) 40P · `advanced` 350P · `premium` 1,400P(장당 고정가, 크기 무관).
|
|
4
|
+
- 같은 요청도 매번 새로 생성·과금하므로 이미지 `idempotencyKey` 는 더 이상 보내지 않습니다(호환을 위해 받기만 하며 폐기 예정입니다).
|
|
5
|
+
- Add the image `quality` option: `basic` (default) 40 points, `advanced` 350 points, `premium` 1,400 points per image regardless of size.
|
|
6
|
+
- Image `idempotencyKey` is deprecated and no longer sent; every image request is generated and charged as a new request.
|
|
7
|
+
|
|
8
|
+
# 4.0.0
|
|
9
|
+
|
|
10
|
+
- Breaking migration: `createTtsJob` now defaults to Gemini `Kore`; retired APICK voices and fallback options are rejected. Use engine-specific voice catalogs instead of legacy `TTS_VOICE_IDS`.
|
|
11
|
+
- Add ChatGPT TTS submission, voice and option queries, shared expressive options and multi-speaker types. Preserve MP3/ASS and billing responses. Normalized/raw string limits are 2,000/8,000 characters.
|
|
12
|
+
- 기본 접수는 Gemini로 전환됐습니다. 기존 APICK 목소리·자동 전환은 종료됐으며, 품질·재개·후보 음원 경로는 409를 반환합니다. ChatGPT와 공통 확장 옵션을 추가했습니다.
|
|
13
|
+
|
|
1
14
|
# 3.11.0
|
|
2
15
|
|
|
3
16
|
- TTS voice metadata includes documented preset age evidence; case aliases remain supported without duplicate catalog entries. Reservation reductions are included in `billing.released`.
|
|
@@ -14,162 +27,162 @@
|
|
|
14
27
|
|
|
15
28
|
Adds the Subagent integration and usage-based installed-agent contract. Existing API contracts remain supported.
|
|
16
29
|
|
|
17
|
-
# Changelog
|
|
18
|
-
|
|
19
|
-
## 3.9.0 — 2026-10-04
|
|
20
|
-
|
|
21
|
-
- `getSkillPerformance()`와 공개 성능표 타입을 추가했습니다. 시험 방식·표본 수·평가일·성공률 구간·미검증 상태를 확인할 수 있습니다.
|
|
22
|
-
- Add `getSkillPerformance()` and report types for methods, sample sizes, evaluation dates, success-rate intervals and untested states.
|
|
23
|
-
|
|
24
|
-
## 3.8.1 — 2026-10-03
|
|
25
|
-
|
|
26
|
-
- 상품별 조회 안내와 공통 인증 가이드 링크를 보강했습니다. API 계약 변경은 없습니다.
|
|
27
|
-
- Document product-specific data guides and shared authentication; API contracts are unchanged.
|
|
28
|
-
|
|
29
|
-
## 3.8.0 — 2026-10-03
|
|
30
|
-
|
|
31
|
-
- 스킬 결과 파일 인증 다운로드와 예상 가격·시간·도구 호출 수 타입 추가.
|
|
32
|
-
- Add authenticated Skill artifact downloads and execution estimate types.
|
|
33
|
-
|
|
34
|
-
## 3.7.0 — 2026-10-02
|
|
35
|
-
|
|
36
|
-
- `searchSkills()` 에 `sort` 를 추가했습니다: `recommended`(추천)·`popular`(인기)·`used`(많이 사용)·`likes`(좋아요순)·`rating`(평점순)·`new`(최신)·`mine`(내 계정이 많이 실행한 Skill)·`liked`(내 계정이 좋아요한 Skill). 생략하면 예전처럼 등록 순서입니다. 지원하지 않는 값은 요청 전에 `RangeError` 가 발생합니다. `SKILL_SORTS` 상수와 `SkillSort` 타입을 공개했습니다.
|
|
37
|
-
- Add `sort` to `searchSkills()`: `recommended`, `popular`, `used`, `likes`, `rating`, `new`, `mine` and `liked` (the last two are scoped to the API key's account). Omitting it keeps registration order. Unsupported values throw a `RangeError` before the request is sent. Export `SKILL_SORTS` and the `SkillSort` type.
|
|
38
|
-
- 검색·상세 응답 타입(`SkillSummary`·`SkillDetail`)에 `usage_label`(사용 건수 구간: `1,000회 미만`, `1,000+`, `1만+` …)·`like_count`·`review_count`·`rating_average` 를 추가했습니다. 검색어는 Skill 의 이름·요약·설명과 판매자 이름에서 찾습니다.
|
|
39
|
-
- Add `usage_label` (a usage tier, not an exact count), `like_count`, `review_count` and `rating_average` to the search and detail response types (`SkillSummary`, `SkillDetail`). The search query now matches a Skill's name, summary, description and seller name.
|
|
40
|
-
- 기존 메서드와 요청·응답 형식은 그대로입니다. / Existing methods and request/response formats are unchanged.
|
|
41
|
-
|
|
42
|
-
## 3.6.2 — 2026-10-02
|
|
43
|
-
|
|
44
|
-
- `TTS_VOICE_IDS`를 현재 지원하는 14개로 갱신했습니다. 제공이 종료된 `v2_ann_f_30s_01`, `v2_f_teen_01`을 상수·타입·문서에서 제거했으며, 이 값을 `voiceId`로 넘기면 요청 전에 `RangeError`가 발생합니다.
|
|
45
|
-
- Update `TTS_VOICE_IDS` to the 14 currently supported voices. The retired `v2_ann_f_30s_01` and `v2_f_teen_01` are removed from the constant, types and docs; passing them as `voiceId` now throws a `RangeError` before the request is sent.
|
|
46
|
-
- TTS 요금이 100자당 10포인트에서 "100자까지 30포인트, 이후 100자당 10포인트"로 바뀌었습니다(100자 30P, 101자 40P, 800자 100P). 한국어 읽기 자동 변환이 이 요금에 포함되며, 과금 기준은 계속 보낸 원문의 글자 수입니다.
|
|
47
|
-
- TTS pricing changed from 10 points per 100 characters to 30 points for up to 100 characters plus 10 points for each additional 100 characters (100 chars 30P, 101 chars 40P, 800 chars 100P). Automatic Korean reading conversion is included, and billing is still based on the character count of the text you send.
|
|
48
|
-
- 모든 TTS 요청에 한국어 읽기 전처리가 자동 적용되어 추가 옵션이나 별도 Skill 호출이 필요하지 않음을 README와 한국어·영어 가이드에 명시했습니다. 원문 기준 요금과 ASS 자막 표기는 유지되며, 정규화에 실패하면 원문으로 합성합니다. 공개 메서드와 요청·응답 형식은 변경하지 않았습니다.
|
|
49
|
-
- Clarify in the README and Korean/English guides that every TTS request automatically applies Korean reading normalization, with no extra option or separate Skill call. Billing and ASS subtitle spelling remain based on the original text; failed normalization falls back to synthesis from that text. No public method or request/response format changes.
|
|
50
|
-
|
|
51
|
-
## 3.6.1 — 2026-10-02
|
|
52
|
-
|
|
53
|
-
- `createTtsJob()`으로 접수한 문장의 숫자·단위·기호·영문 약어를 문맥에 맞는 한글 읽기로 자동 변환해 합성한다는 안내를 README와 한국어·영어 가이드에 추가했습니다. 과금 글자 수와 요금은 보낸 원문 기준이고 요청·응답 형식은 그대로이며, ASS 자막은 보낸 원문 표기로 제공됩니다. 문서만 바뀌었습니다.
|
|
54
|
-
- Document in the README and Korean/English guides that text passed to `createTtsJob()` has its numbers, units, symbols and English abbreviations automatically converted into context-appropriate Korean readings before synthesis. Billing is based on the text you send, request and response formats are unchanged, and ASS subtitles keep the text as you sent it. Documentation only.
|
|
55
|
-
|
|
56
|
-
## 3.6.0 — 2026-10-02
|
|
57
|
-
|
|
58
|
-
- Skills 메서드 8종을 추가했습니다: `searchSkills()`, `getSkill()`, `quoteSkill()`, `runSkill()`, `getSkillRun()`, `getSkillRunResult()`, `cancelSkillRun()`, `skillUsage()`. 요청·응답이 JSON 이며 응답은 봉투 없이 `data` 에 담깁니다.
|
|
59
|
-
- Add eight Skills methods to search, inspect, quote, run, read, fetch the result of, cancel and list Skill runs. Requests and responses are JSON; responses are returned as-is in `data`.
|
|
60
|
-
- `runSkill()` 은 `idempotencyKey` 가 필수이며 `Idempotency-Key` 헤더로 보냅니다. 결과가 약속한 형식으로 반환된 실행만 차감됩니다.
|
|
61
|
-
- 생성형 AI 를 쓰는 Skill 은 실행마다 실제 사용량만큼 금액이 달라집니다. `quoteSkill()` 이 예상 금액(`estimated_points`)과 최대 금액(`max_points`)을 돌려주며, `maxCostPoints` 에는 `max_points` 를 넘기세요.
|
|
62
|
-
- For Skills that use generative AI the charge varies per run with actual usage. `quoteSkill()` returns `estimated_points` and `max_points`; pass `max_points` as `maxCostPoints`.
|
|
63
|
-
- `runSkill()` requires `idempotencyKey`, sent as the `Idempotency-Key` header. Only runs that return a result in the promised format are charged.
|
|
64
|
-
- `ApickApiError` 에 선택적 `details` 를 추가했습니다. Skills 오류 코드는 `serviceCode` 로 전달됩니다. `SKILL_CATEGORIES` 상수와 Skills 타입(`SkillSummary`, `SkillDetail`, `SkillQuote`, `SkillRun` 등)을 공개했습니다.
|
|
65
|
-
- Add optional `details` to `ApickApiError`; Skills error codes are surfaced through `serviceCode`. Export `SKILL_CATEGORIES` and the Skills types.
|
|
66
|
-
|
|
67
|
-
## 3.5.0 — 2026-09-30
|
|
68
|
-
|
|
69
|
-
- 간편인증 조회 상품 2종을 추가했습니다. `requestCashReceiptDeduction()`/`getCashReceiptDeduction()`은 현금영수증 소득공제 내역을 `incomeYears`(1~3)로, `requestTaxReturnHistory()`/`getTaxReturnHistory()`는 국세 신고내역을 `years`(1~10)로 조회합니다.
|
|
70
|
-
- Add two simple-auth data products: cash receipt income deductions (`incomeYears` 1-3) and national tax return history (`years` 1-10), each with a `request*()`/`get*()` pair and result payload types.
|
|
71
|
-
- 유튜브 공개 영상 API 4종을 추가했습니다: `youtubeMetadata()`, `youtubeThumbnail()`(JPG), `youtubeSubtitleList()`, `youtubeSubtitle()`(VTT·SRT·TXT).
|
|
72
|
-
- Add four public YouTube video methods: metadata, thumbnail (JPG), subtitle language list, and subtitle download (VTT/SRT/TXT).
|
|
73
|
-
|
|
74
|
-
## 3.4.1 — 2026-09-28
|
|
75
|
-
|
|
76
|
-
- README와 한국어·영어 가이드의 간편인증 5종 예제에 모든 진행 상태와 `resultAvailable` 종료 기준을 적용했습니다. 전체·부분 성공, 인증 거부·만료·실패와 `RESULT_EXPIRED`를 구분합니다.
|
|
77
|
-
- Align all five simple-auth polling examples in the README and Korean/English guides with every progress state and the `resultAvailable` completion criterion. Distinguish full/partial success, rejected/expired authentication, failure, and `RESULT_EXPIRED`.
|
|
78
|
-
- 순차 폴링 간격을 5→10→20→30초로 늘린 뒤 30초를 유지하며, 인증·전체 대기시간 제한과 자동 재접수 방지를 안내합니다. 문서 코드를 직접 실행하는 회귀 테스트를 추가했습니다.
|
|
79
|
-
- Document sequential polling at 5→10→20→30 seconds, capped at 30 seconds, with authentication/overall waiting limits and no automatic resubmission. Add regression tests that execute the documentation examples.
|
|
80
|
-
|
|
81
|
-
## 3.4.0 — 2026-09-27
|
|
82
|
-
|
|
83
|
-
- 간편인증 기반 조회 상품 5종(재직·보험료 확인, 금융소득 조회, 국민연금 가입내역, 운전면허 조회, 국가 건강검진 결과)을 추가했습니다. 각 상품은 `request*()`로 본인 간편인증을 접수하고 `get*()`로 상태·결과를 폴링합니다.
|
|
84
|
-
- Add five simple-auth-based data lookup products (employment/insurance premium check, financial income, National Pension join history, driver's license, national health checkup). Each product accepts a `request*()` call for identity verification and polls status/result with `get*()`.
|
|
85
|
-
- `AUTH_PROVIDERS`(13종 간편인증 수단)와 `AuthProvider`, `DataRequestAcceptedData`, `DataRequestResult<T>` 타입, 상품별 결과 타입(`EmploymentResultPayload` 등)을 공개했습니다.
|
|
86
|
-
- Export `AUTH_PROVIDERS` (13 supported simple-auth providers), the `AuthProvider` type, `DataRequestAcceptedData`/`DataRequestResult<T>` envelopes, and per-product result payload types (e.g. `EmploymentResultPayload`).
|
|
87
|
-
- 재조회 만료(`RESULT_EXPIRED`)·인증 만료·거절·수집 실패는 `data.errorCode`로 구분됩니다.
|
|
88
|
-
- `RESULT_EXPIRED`, `AUTH_EXPIRED`, `AUTH_REJECTED`, and `COLLECT_FAILED` are surfaced through `data.errorCode`.
|
|
89
|
-
|
|
90
|
-
## 3.3.0 — 2026-09-21
|
|
91
|
-
|
|
92
|
-
- 모든 REST 요청의 인증 헤더를 `CL_AUTH_KEY` 에서 표준 `Authorization: Bearer <API 키>` 로 전환했습니다. 서버가 전환 기간 동안 두 헤더를 모두 받으므로 기존 호출도 계속 동작합니다.
|
|
93
|
-
- Send REST requests with the standard `Authorization: Bearer <API key>` header instead of `CL_AUTH_KEY`. Both headers are accepted during the migration window.
|
|
94
|
-
- Mask bearer tokens in error output alongside the legacy header.
|
|
95
|
-
- Synchronize all 16 current TTS voice IDs and masking type 4 with the public REST contract.
|
|
96
|
-
|
|
97
|
-
- Send all REST request bodies as multipart/form-data, including flattened nested arrays and objects. Keep existing method signatures and JSON/file responses.
|
|
98
|
-
- REST 요청을 multipart/form-data로 통일하고 중첩 입력·파일·불리언의 호환 테스트를 추가했습니다. 기존 메서드와 응답 타입은 유지합니다.
|
|
99
|
-
- Document OpenAPI/Postman downloads and compatibility with older JSON callers.
|
|
100
|
-
|
|
101
|
-
## 3.2.0 — 2026-09-14
|
|
102
|
-
|
|
103
|
-
- Seedance 참조 영상 작업에 `referenceAudios`(MP3·WAV) 입력을 추가했습니다.
|
|
104
|
-
- Add video generation version selection documentation and compatibility tests.
|
|
105
|
-
- 영상 생성 버전 선택, 버전별 옵션·요금 안내와 호환 검증을 추가했습니다.
|
|
106
|
-
- Add createVideoJob, getVideoJob, downloadVideoResult and public TypeScript types.
|
|
107
|
-
- Document and verify Seedance 2.0 Fast and Mini tier pass-through.
|
|
108
|
-
|
|
109
|
-
## 3.1.0 - 2026-09-08
|
|
110
|
-
|
|
111
|
-
- TTS 발화별 검수 이력, 후보 WAV 조회, 멱등 키를 사용하는 같은 작업 재개 메서드를 추가했습니다.
|
|
112
|
-
- Added TTS quality history, candidate WAV downloads, and idempotent job recovery methods.
|
|
113
|
-
|
|
114
|
-
## 3.0.0 - 2026-09-05
|
|
115
|
-
|
|
116
|
-
- 이미지 프롬프트 허용 길이를 최대 28,000자로 확대했습니다.
|
|
117
|
-
- 작업 접수 시 전체 포인트를 먼저 차감하고 실패한 이미지의 포인트를 즉시 환급하는 계약을 반영했습니다.
|
|
118
|
-
- 접수된 이미지 작업은 취소할 수 없도록 `cancelImageJob` 메서드와 `cancelled` 상태를 제거했습니다.
|
|
119
|
-
|
|
120
|
-
## 2.4.0 - 2026-09-05
|
|
121
|
-
|
|
122
|
-
- 이미지 장수 옵션을 의미가 분명한 `imageCount`로 바꾸고 압축 조정 옵션을 제거했습니다.
|
|
123
|
-
- 이미지 크기를 5개 표준 크기 중에서만 선택하도록 타입과 런타임 검증을 강화했습니다.
|
|
124
|
-
- 생성 요청에 선택적 `referenceImage`를 더해 참고 이미지와 텍스트를 함께 사용할 수 있습니다.
|
|
125
|
-
|
|
126
|
-
## 2.3.1 - 2026-09-05
|
|
127
|
-
|
|
128
|
-
- 이미지 편집 입력에서 마스크 파일을 제거하고 원본 이미지와 프롬프트만 받도록 계약을 단순화했습니다.
|
|
129
|
-
|
|
130
|
-
## 2.3.0 - 2026-09-05
|
|
131
|
-
|
|
132
|
-
- 이미지 생성·편집과 최대 50장 비동기 작업 메서드 8종을 추가했습니다.
|
|
133
|
-
- 이미지당 25포인트, 성공분 과금, 멱등 키, 24시간 결과 보관 계약을 문서화했습니다.
|
|
134
|
-
|
|
135
|
-
## 2.2.0 - 2026-09-03
|
|
136
|
-
|
|
137
|
-
- `maskResidenceCard()`의 개인정보 마스킹 대상을 외국인등록증·영주증·외국국적동포 국내거소신고증으로 확대했습니다.
|
|
138
|
-
- 요청·응답 형식과 `document_type: residence_card` 계약은 유지합니다.
|
|
139
|
-
- 진위확인 API의 지원 범위는 기존 외국인등록증으로 유지됩니다.
|
|
140
|
-
|
|
141
|
-
## 2.1.0 - 2026-09-01
|
|
142
|
-
|
|
143
|
-
- `downloadTtsSubtitles(jobId)`로 발화 타이밍 ASS 자막을 별도 1회 다운로드할 수 있습니다.
|
|
144
|
-
- TTS 상태 타입에 `subtitles_available`을 추가했습니다.
|
|
145
|
-
- 허용 IP 공란, 단일 IPv4·CIDR 등록, 즉시 반영 규칙을 한영 문서에 추가했습니다.
|
|
146
|
-
|
|
147
|
-
## 2.0.1 - 2026-08-31
|
|
148
|
-
|
|
149
|
-
- TTS 작업 취소 범위를 `waiting`과 `processing` 상태로 확장했습니다.
|
|
150
|
-
- 실행 중 취소도 접수 시 과금된 금액을 환불하지 않는 계약을 한영 문서에 반영했습니다.
|
|
151
|
-
- 17개 TTS `voice_id`의 사용자 표시 이름을 공개 문서에 추가했습니다.
|
|
152
|
-
|
|
153
|
-
## 2.0.0 - 2026-08-30
|
|
154
|
-
|
|
155
|
-
- 종료된 동기 `textToSpeech()` 계약을 제거했습니다.
|
|
156
|
-
- `createTtsJob()`, `getTtsJob()`, `cancelTtsJob()`, `downloadTtsResult()`로 비동기 한국어 TTS Jobs 계약을 제공합니다.
|
|
157
|
-
- 지원 목소리, 최대 800자, 상태 조회, 대기 중 취소, 결과 MP3(`audio/mpeg`) 1회 다운로드를 문서화했습니다.
|
|
158
|
-
- 정식 게시 전 지원 목소리를 17개 중립 내레이션 음성으로 확장하고 `TTS_VOICE_IDS`를 추가했습니다.
|
|
159
|
-
|
|
160
|
-
## 1.1.1 - 2026-08-30
|
|
161
|
-
|
|
162
|
-
- 공개된 25개 API 계약에 종료 대상 이미지 생성 기능이 포함되지 않았음을 재검증했습니다.
|
|
163
|
-
- 기능 및 메서드 호환성 변경 없이 릴리스 메타데이터를 갱신했습니다.
|
|
164
|
-
|
|
165
|
-
## 1.1.0 - 2026-08-29
|
|
166
|
-
|
|
167
|
-
- 주민등록번호, 외국인등록증, 여권, 주민등록증, 운전면허증 마스킹 메서드 5종을 추가했습니다.
|
|
168
|
-
- 신분증 처리 오류 코드를 `ApickApiError.serviceCode`로 제공합니다.
|
|
169
|
-
|
|
170
|
-
## 1.0.0
|
|
171
|
-
|
|
172
|
-
- Initial public release.
|
|
173
|
-
- Added 20 focused APICK service methods.
|
|
174
|
-
- Added JSON, multipart image upload, and binary file response support.
|
|
175
|
-
- Added ESM, CommonJS, and TypeScript declarations.
|
|
30
|
+
# Changelog
|
|
31
|
+
|
|
32
|
+
## 3.9.0 — 2026-10-04
|
|
33
|
+
|
|
34
|
+
- `getSkillPerformance()`와 공개 성능표 타입을 추가했습니다. 시험 방식·표본 수·평가일·성공률 구간·미검증 상태를 확인할 수 있습니다.
|
|
35
|
+
- Add `getSkillPerformance()` and report types for methods, sample sizes, evaluation dates, success-rate intervals and untested states.
|
|
36
|
+
|
|
37
|
+
## 3.8.1 — 2026-10-03
|
|
38
|
+
|
|
39
|
+
- 상품별 조회 안내와 공통 인증 가이드 링크를 보강했습니다. API 계약 변경은 없습니다.
|
|
40
|
+
- Document product-specific data guides and shared authentication; API contracts are unchanged.
|
|
41
|
+
|
|
42
|
+
## 3.8.0 — 2026-10-03
|
|
43
|
+
|
|
44
|
+
- 스킬 결과 파일 인증 다운로드와 예상 가격·시간·도구 호출 수 타입 추가.
|
|
45
|
+
- Add authenticated Skill artifact downloads and execution estimate types.
|
|
46
|
+
|
|
47
|
+
## 3.7.0 — 2026-10-02
|
|
48
|
+
|
|
49
|
+
- `searchSkills()` 에 `sort` 를 추가했습니다: `recommended`(추천)·`popular`(인기)·`used`(많이 사용)·`likes`(좋아요순)·`rating`(평점순)·`new`(최신)·`mine`(내 계정이 많이 실행한 Skill)·`liked`(내 계정이 좋아요한 Skill). 생략하면 예전처럼 등록 순서입니다. 지원하지 않는 값은 요청 전에 `RangeError` 가 발생합니다. `SKILL_SORTS` 상수와 `SkillSort` 타입을 공개했습니다.
|
|
50
|
+
- Add `sort` to `searchSkills()`: `recommended`, `popular`, `used`, `likes`, `rating`, `new`, `mine` and `liked` (the last two are scoped to the API key's account). Omitting it keeps registration order. Unsupported values throw a `RangeError` before the request is sent. Export `SKILL_SORTS` and the `SkillSort` type.
|
|
51
|
+
- 검색·상세 응답 타입(`SkillSummary`·`SkillDetail`)에 `usage_label`(사용 건수 구간: `1,000회 미만`, `1,000+`, `1만+` …)·`like_count`·`review_count`·`rating_average` 를 추가했습니다. 검색어는 Skill 의 이름·요약·설명과 판매자 이름에서 찾습니다.
|
|
52
|
+
- Add `usage_label` (a usage tier, not an exact count), `like_count`, `review_count` and `rating_average` to the search and detail response types (`SkillSummary`, `SkillDetail`). The search query now matches a Skill's name, summary, description and seller name.
|
|
53
|
+
- 기존 메서드와 요청·응답 형식은 그대로입니다. / Existing methods and request/response formats are unchanged.
|
|
54
|
+
|
|
55
|
+
## 3.6.2 — 2026-10-02
|
|
56
|
+
|
|
57
|
+
- `TTS_VOICE_IDS`를 현재 지원하는 14개로 갱신했습니다. 제공이 종료된 `v2_ann_f_30s_01`, `v2_f_teen_01`을 상수·타입·문서에서 제거했으며, 이 값을 `voiceId`로 넘기면 요청 전에 `RangeError`가 발생합니다.
|
|
58
|
+
- Update `TTS_VOICE_IDS` to the 14 currently supported voices. The retired `v2_ann_f_30s_01` and `v2_f_teen_01` are removed from the constant, types and docs; passing them as `voiceId` now throws a `RangeError` before the request is sent.
|
|
59
|
+
- TTS 요금이 100자당 10포인트에서 "100자까지 30포인트, 이후 100자당 10포인트"로 바뀌었습니다(100자 30P, 101자 40P, 800자 100P). 한국어 읽기 자동 변환이 이 요금에 포함되며, 과금 기준은 계속 보낸 원문의 글자 수입니다.
|
|
60
|
+
- TTS pricing changed from 10 points per 100 characters to 30 points for up to 100 characters plus 10 points for each additional 100 characters (100 chars 30P, 101 chars 40P, 800 chars 100P). Automatic Korean reading conversion is included, and billing is still based on the character count of the text you send.
|
|
61
|
+
- 모든 TTS 요청에 한국어 읽기 전처리가 자동 적용되어 추가 옵션이나 별도 Skill 호출이 필요하지 않음을 README와 한국어·영어 가이드에 명시했습니다. 원문 기준 요금과 ASS 자막 표기는 유지되며, 정규화에 실패하면 원문으로 합성합니다. 공개 메서드와 요청·응답 형식은 변경하지 않았습니다.
|
|
62
|
+
- Clarify in the README and Korean/English guides that every TTS request automatically applies Korean reading normalization, with no extra option or separate Skill call. Billing and ASS subtitle spelling remain based on the original text; failed normalization falls back to synthesis from that text. No public method or request/response format changes.
|
|
63
|
+
|
|
64
|
+
## 3.6.1 — 2026-10-02
|
|
65
|
+
|
|
66
|
+
- `createTtsJob()`으로 접수한 문장의 숫자·단위·기호·영문 약어를 문맥에 맞는 한글 읽기로 자동 변환해 합성한다는 안내를 README와 한국어·영어 가이드에 추가했습니다. 과금 글자 수와 요금은 보낸 원문 기준이고 요청·응답 형식은 그대로이며, ASS 자막은 보낸 원문 표기로 제공됩니다. 문서만 바뀌었습니다.
|
|
67
|
+
- Document in the README and Korean/English guides that text passed to `createTtsJob()` has its numbers, units, symbols and English abbreviations automatically converted into context-appropriate Korean readings before synthesis. Billing is based on the text you send, request and response formats are unchanged, and ASS subtitles keep the text as you sent it. Documentation only.
|
|
68
|
+
|
|
69
|
+
## 3.6.0 — 2026-10-02
|
|
70
|
+
|
|
71
|
+
- Skills 메서드 8종을 추가했습니다: `searchSkills()`, `getSkill()`, `quoteSkill()`, `runSkill()`, `getSkillRun()`, `getSkillRunResult()`, `cancelSkillRun()`, `skillUsage()`. 요청·응답이 JSON 이며 응답은 봉투 없이 `data` 에 담깁니다.
|
|
72
|
+
- Add eight Skills methods to search, inspect, quote, run, read, fetch the result of, cancel and list Skill runs. Requests and responses are JSON; responses are returned as-is in `data`.
|
|
73
|
+
- `runSkill()` 은 `idempotencyKey` 가 필수이며 `Idempotency-Key` 헤더로 보냅니다. 결과가 약속한 형식으로 반환된 실행만 차감됩니다.
|
|
74
|
+
- 생성형 AI 를 쓰는 Skill 은 실행마다 실제 사용량만큼 금액이 달라집니다. `quoteSkill()` 이 예상 금액(`estimated_points`)과 최대 금액(`max_points`)을 돌려주며, `maxCostPoints` 에는 `max_points` 를 넘기세요.
|
|
75
|
+
- For Skills that use generative AI the charge varies per run with actual usage. `quoteSkill()` returns `estimated_points` and `max_points`; pass `max_points` as `maxCostPoints`.
|
|
76
|
+
- `runSkill()` requires `idempotencyKey`, sent as the `Idempotency-Key` header. Only runs that return a result in the promised format are charged.
|
|
77
|
+
- `ApickApiError` 에 선택적 `details` 를 추가했습니다. Skills 오류 코드는 `serviceCode` 로 전달됩니다. `SKILL_CATEGORIES` 상수와 Skills 타입(`SkillSummary`, `SkillDetail`, `SkillQuote`, `SkillRun` 등)을 공개했습니다.
|
|
78
|
+
- Add optional `details` to `ApickApiError`; Skills error codes are surfaced through `serviceCode`. Export `SKILL_CATEGORIES` and the Skills types.
|
|
79
|
+
|
|
80
|
+
## 3.5.0 — 2026-09-30
|
|
81
|
+
|
|
82
|
+
- 간편인증 조회 상품 2종을 추가했습니다. `requestCashReceiptDeduction()`/`getCashReceiptDeduction()`은 현금영수증 소득공제 내역을 `incomeYears`(1~3)로, `requestTaxReturnHistory()`/`getTaxReturnHistory()`는 국세 신고내역을 `years`(1~10)로 조회합니다.
|
|
83
|
+
- Add two simple-auth data products: cash receipt income deductions (`incomeYears` 1-3) and national tax return history (`years` 1-10), each with a `request*()`/`get*()` pair and result payload types.
|
|
84
|
+
- 유튜브 공개 영상 API 4종을 추가했습니다: `youtubeMetadata()`, `youtubeThumbnail()`(JPG), `youtubeSubtitleList()`, `youtubeSubtitle()`(VTT·SRT·TXT).
|
|
85
|
+
- Add four public YouTube video methods: metadata, thumbnail (JPG), subtitle language list, and subtitle download (VTT/SRT/TXT).
|
|
86
|
+
|
|
87
|
+
## 3.4.1 — 2026-09-28
|
|
88
|
+
|
|
89
|
+
- README와 한국어·영어 가이드의 간편인증 5종 예제에 모든 진행 상태와 `resultAvailable` 종료 기준을 적용했습니다. 전체·부분 성공, 인증 거부·만료·실패와 `RESULT_EXPIRED`를 구분합니다.
|
|
90
|
+
- Align all five simple-auth polling examples in the README and Korean/English guides with every progress state and the `resultAvailable` completion criterion. Distinguish full/partial success, rejected/expired authentication, failure, and `RESULT_EXPIRED`.
|
|
91
|
+
- 순차 폴링 간격을 5→10→20→30초로 늘린 뒤 30초를 유지하며, 인증·전체 대기시간 제한과 자동 재접수 방지를 안내합니다. 문서 코드를 직접 실행하는 회귀 테스트를 추가했습니다.
|
|
92
|
+
- Document sequential polling at 5→10→20→30 seconds, capped at 30 seconds, with authentication/overall waiting limits and no automatic resubmission. Add regression tests that execute the documentation examples.
|
|
93
|
+
|
|
94
|
+
## 3.4.0 — 2026-09-27
|
|
95
|
+
|
|
96
|
+
- 간편인증 기반 조회 상품 5종(재직·보험료 확인, 금융소득 조회, 국민연금 가입내역, 운전면허 조회, 국가 건강검진 결과)을 추가했습니다. 각 상품은 `request*()`로 본인 간편인증을 접수하고 `get*()`로 상태·결과를 폴링합니다.
|
|
97
|
+
- Add five simple-auth-based data lookup products (employment/insurance premium check, financial income, National Pension join history, driver's license, national health checkup). Each product accepts a `request*()` call for identity verification and polls status/result with `get*()`.
|
|
98
|
+
- `AUTH_PROVIDERS`(13종 간편인증 수단)와 `AuthProvider`, `DataRequestAcceptedData`, `DataRequestResult<T>` 타입, 상품별 결과 타입(`EmploymentResultPayload` 등)을 공개했습니다.
|
|
99
|
+
- Export `AUTH_PROVIDERS` (13 supported simple-auth providers), the `AuthProvider` type, `DataRequestAcceptedData`/`DataRequestResult<T>` envelopes, and per-product result payload types (e.g. `EmploymentResultPayload`).
|
|
100
|
+
- 재조회 만료(`RESULT_EXPIRED`)·인증 만료·거절·수집 실패는 `data.errorCode`로 구분됩니다.
|
|
101
|
+
- `RESULT_EXPIRED`, `AUTH_EXPIRED`, `AUTH_REJECTED`, and `COLLECT_FAILED` are surfaced through `data.errorCode`.
|
|
102
|
+
|
|
103
|
+
## 3.3.0 — 2026-09-21
|
|
104
|
+
|
|
105
|
+
- 모든 REST 요청의 인증 헤더를 `CL_AUTH_KEY` 에서 표준 `Authorization: Bearer <API 키>` 로 전환했습니다. 서버가 전환 기간 동안 두 헤더를 모두 받으므로 기존 호출도 계속 동작합니다.
|
|
106
|
+
- Send REST requests with the standard `Authorization: Bearer <API key>` header instead of `CL_AUTH_KEY`. Both headers are accepted during the migration window.
|
|
107
|
+
- Mask bearer tokens in error output alongside the legacy header.
|
|
108
|
+
- Synchronize all 16 current TTS voice IDs and masking type 4 with the public REST contract.
|
|
109
|
+
|
|
110
|
+
- Send all REST request bodies as multipart/form-data, including flattened nested arrays and objects. Keep existing method signatures and JSON/file responses.
|
|
111
|
+
- REST 요청을 multipart/form-data로 통일하고 중첩 입력·파일·불리언의 호환 테스트를 추가했습니다. 기존 메서드와 응답 타입은 유지합니다.
|
|
112
|
+
- Document OpenAPI/Postman downloads and compatibility with older JSON callers.
|
|
113
|
+
|
|
114
|
+
## 3.2.0 — 2026-09-14
|
|
115
|
+
|
|
116
|
+
- Seedance 참조 영상 작업에 `referenceAudios`(MP3·WAV) 입력을 추가했습니다.
|
|
117
|
+
- Add video generation version selection documentation and compatibility tests.
|
|
118
|
+
- 영상 생성 버전 선택, 버전별 옵션·요금 안내와 호환 검증을 추가했습니다.
|
|
119
|
+
- Add createVideoJob, getVideoJob, downloadVideoResult and public TypeScript types.
|
|
120
|
+
- Document and verify Seedance 2.0 Fast and Mini tier pass-through.
|
|
121
|
+
|
|
122
|
+
## 3.1.0 - 2026-09-08
|
|
123
|
+
|
|
124
|
+
- TTS 발화별 검수 이력, 후보 WAV 조회, 멱등 키를 사용하는 같은 작업 재개 메서드를 추가했습니다.
|
|
125
|
+
- Added TTS quality history, candidate WAV downloads, and idempotent job recovery methods.
|
|
126
|
+
|
|
127
|
+
## 3.0.0 - 2026-09-05
|
|
128
|
+
|
|
129
|
+
- 이미지 프롬프트 허용 길이를 최대 28,000자로 확대했습니다.
|
|
130
|
+
- 작업 접수 시 전체 포인트를 먼저 차감하고 실패한 이미지의 포인트를 즉시 환급하는 계약을 반영했습니다.
|
|
131
|
+
- 접수된 이미지 작업은 취소할 수 없도록 `cancelImageJob` 메서드와 `cancelled` 상태를 제거했습니다.
|
|
132
|
+
|
|
133
|
+
## 2.4.0 - 2026-09-05
|
|
134
|
+
|
|
135
|
+
- 이미지 장수 옵션을 의미가 분명한 `imageCount`로 바꾸고 압축 조정 옵션을 제거했습니다.
|
|
136
|
+
- 이미지 크기를 5개 표준 크기 중에서만 선택하도록 타입과 런타임 검증을 강화했습니다.
|
|
137
|
+
- 생성 요청에 선택적 `referenceImage`를 더해 참고 이미지와 텍스트를 함께 사용할 수 있습니다.
|
|
138
|
+
|
|
139
|
+
## 2.3.1 - 2026-09-05
|
|
140
|
+
|
|
141
|
+
- 이미지 편집 입력에서 마스크 파일을 제거하고 원본 이미지와 프롬프트만 받도록 계약을 단순화했습니다.
|
|
142
|
+
|
|
143
|
+
## 2.3.0 - 2026-09-05
|
|
144
|
+
|
|
145
|
+
- 이미지 생성·편집과 최대 50장 비동기 작업 메서드 8종을 추가했습니다.
|
|
146
|
+
- 이미지당 25포인트, 성공분 과금, 멱등 키, 24시간 결과 보관 계약을 문서화했습니다.
|
|
147
|
+
|
|
148
|
+
## 2.2.0 - 2026-09-03
|
|
149
|
+
|
|
150
|
+
- `maskResidenceCard()`의 개인정보 마스킹 대상을 외국인등록증·영주증·외국국적동포 국내거소신고증으로 확대했습니다.
|
|
151
|
+
- 요청·응답 형식과 `document_type: residence_card` 계약은 유지합니다.
|
|
152
|
+
- 진위확인 API의 지원 범위는 기존 외국인등록증으로 유지됩니다.
|
|
153
|
+
|
|
154
|
+
## 2.1.0 - 2026-09-01
|
|
155
|
+
|
|
156
|
+
- `downloadTtsSubtitles(jobId)`로 발화 타이밍 ASS 자막을 별도 1회 다운로드할 수 있습니다.
|
|
157
|
+
- TTS 상태 타입에 `subtitles_available`을 추가했습니다.
|
|
158
|
+
- 허용 IP 공란, 단일 IPv4·CIDR 등록, 즉시 반영 규칙을 한영 문서에 추가했습니다.
|
|
159
|
+
|
|
160
|
+
## 2.0.1 - 2026-08-31
|
|
161
|
+
|
|
162
|
+
- TTS 작업 취소 범위를 `waiting`과 `processing` 상태로 확장했습니다.
|
|
163
|
+
- 실행 중 취소도 접수 시 과금된 금액을 환불하지 않는 계약을 한영 문서에 반영했습니다.
|
|
164
|
+
- 17개 TTS `voice_id`의 사용자 표시 이름을 공개 문서에 추가했습니다.
|
|
165
|
+
|
|
166
|
+
## 2.0.0 - 2026-08-30
|
|
167
|
+
|
|
168
|
+
- 종료된 동기 `textToSpeech()` 계약을 제거했습니다.
|
|
169
|
+
- `createTtsJob()`, `getTtsJob()`, `cancelTtsJob()`, `downloadTtsResult()`로 비동기 한국어 TTS Jobs 계약을 제공합니다.
|
|
170
|
+
- 지원 목소리, 최대 800자, 상태 조회, 대기 중 취소, 결과 MP3(`audio/mpeg`) 1회 다운로드를 문서화했습니다.
|
|
171
|
+
- 정식 게시 전 지원 목소리를 17개 중립 내레이션 음성으로 확장하고 `TTS_VOICE_IDS`를 추가했습니다.
|
|
172
|
+
|
|
173
|
+
## 1.1.1 - 2026-08-30
|
|
174
|
+
|
|
175
|
+
- 공개된 25개 API 계약에 종료 대상 이미지 생성 기능이 포함되지 않았음을 재검증했습니다.
|
|
176
|
+
- 기능 및 메서드 호환성 변경 없이 릴리스 메타데이터를 갱신했습니다.
|
|
177
|
+
|
|
178
|
+
## 1.1.0 - 2026-08-29
|
|
179
|
+
|
|
180
|
+
- 주민등록번호, 외국인등록증, 여권, 주민등록증, 운전면허증 마스킹 메서드 5종을 추가했습니다.
|
|
181
|
+
- 신분증 처리 오류 코드를 `ApickApiError.serviceCode`로 제공합니다.
|
|
182
|
+
|
|
183
|
+
## 1.0.0
|
|
184
|
+
|
|
185
|
+
- Initial public release.
|
|
186
|
+
- Added 20 focused APICK service methods.
|
|
187
|
+
- Added JSON, multipart image upload, and binary file response support.
|
|
188
|
+
- Added ESM, CommonJS, and TypeScript declarations.
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 APICK
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 APICK
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|