API 레퍼런스 | Wambesha

API 레퍼런스는 영어로만 제공됩니다.

API 레퍼런스 — v1

https://api.wambesha.com · Bearer 인증 · JSON

v1의 모든 엔드포인트를 파라미터, 요청 및 응답 예시, 반환될 수 있는 오류와 함께 보여 드려요. 엔드포인트 설명은 영어로 제공돼요.

인증

Your API key, presented as a Bearer token. Keys are per-account and carry a plan; the plan decides which endpoints answer and what your quota is. Never embed a key in a browser client — it is a credential, and a browser cannot keep one.

HTTP

Authorization: Bearer $WAMBESHA_API_KEY

공개 데모 키를 지원하는 엔드포인트에서는 “체험해 보기” 스니펫에 데모 키가 들어 있어서 그대로 실행돼요. 그 밖의 스니펫에는 회원님의 키가 필요해요. 데모 키는 API를 체험하는 용도로만 쓸 수 있어요. 매일 교체되고, 언제든지 비활성화될 수 있으며, 프로덕션에서는 절대 사용하면 안 돼요. 직접 만드는 모든 것에는 회원님의 키를 사용하세요.

응답 헤더

X-Request-ID인증된 모든 응답
The id of this request, on every response - success or error. Quote it to support: it is how we find your request in our logs. An X-Request-ID you send is honoured and echoed back, so you can use your own; otherwise we generate one. /v1 error bodies carry no trace id of their own.
X-Quota-Reset인증된 모든 응답
RFC 3339 instant at which the billing period rolls. Present on every response to a request whose key was metered - every 2xx, every error a handler returned, and the quota 429. Absent on a refusal that happens before metering: a missing or unknown key (401), a restricted key or a plan that does not carry the endpoint (403), a public demo-key gate refusal, and the pre-authentication flood throttle.
X-Calls-Remaining인증된 모든 응답
Requests left in the period after this one, never below 0. Present whenever X-Quota-Reset is (see there for when a response carries no quota headers).
X-Verifications-Remaining인증된 모든 응답
How many verifications you can still make before a limit stops you. The daily limit and the monthly allowance are counted separately; this is whichever of the two runs out first. Sent whenever X-Quota-Reset is.
X-Quota-Grace인증된 모든 응답
true when THIS request fell inside the 10% grace band above a monthly ceiling. A grace request is served and is not billed; treat true as "back off now", not as headroom. Always true or false, never absent when the other quota headers are present.
Retry-After429 응답에서만
Seconds to wait before retrying. On every 429 - the quota hard stop, the public demo key's limits, and the pre-authentication flood throttle (which carries this header alone, because no key has been read yet).
X-Demo-Challenge-Mode데모 키에서만
Sent only on responses to the public demo key. The value interactive asks the documentation page to show the visible verification widget - it is sent once a browser has made more than five runs in ten minutes or has received a 429. The page then repeats the header, X-Demo-Challenge-Mode: interactive, on its next request, with the widget's token in X-Demo-Challenge. Requests made with your own key never receive it.

오류

모든 오류의 본문 형식은 같아요. HTTP 상태, 분기 처리에 쓸 수 있는 고정 코드, 사람이 읽을 메시지, 그리고 값이 잘못된 경우의 필드 오류가 포함돼요. 문의하실 때 특정 요청을 알려 주시려면 해당 요청의 X-Request-ID 응답 헤더를 사용하세요.

기록된 응답

Content-Type: application/json
X-Request-ID: 5f3c9a1e7b2d4c60

GET/v1/search

{
  "timestamp": "2026-09-27T12:00:00Z",
  "status": 400,
  "error": "Bad Request",
  "message": "Enter at least 2 characters to search.",
  "path": "/v1/search",
  "errors": [
    {
      "field": "q",
      "rejectedValue": "a",
      "message": "Enter at least 2 characters to search."
    }
  ],
  "metadata": {
    "errorCode": "CATALOG_SEARCH_QUERY_TOO_SHORT"
  },
  "code": "validation-failed"
}

400

validation-failed400405
The request is not one this operation accepts - a parameter outside its rule, a missing required parameter, an unsupported language, or a method the route does not take.
조치 방법Fix the request; errors names the parameter. Retrying it unchanged fails the same way.
cursor-invalid400
The cursor is malformed, stale, from a different filter set or sort, or past what your key may page.
조치 방법Drop the cursor and request the first page again.
unauthenticated401
No key, or a key that is unknown, malformed, expired or revoked - one answer for all of them. Also what a switched-off public demo key answers.
조치 방법Send a valid key as Authorization: Bearer <key>; if it was rotated, use its replacement.
forbidden403
The key is valid but a restriction its owner set - a scope, an IP allowlist, a referrer allowlist - excludes this request. Also a key rotating a key other than itself.
조치 방법Call from an allowed place or change the key's restrictions in the console.
plan-required403
Your plan does not include this operation or this freshness, or the public demo key was used for something it cannot reach.
조치 방법Upgrade the plan, or use your own key rather than the demo key.
challenge-required403
A browser call with the public demo key carried no valid bot-check token.
조치 방법Complete the check on the page and run the request again. Not sent to paying keys.
not-found404
Nothing matches the reference, or the reference is not a valid id.
조치 방법Check the id; a merged record answers 200 with its survivor, so 404 means it never existed here.
conflict409
The request contradicts current state - a key already rotated, revoked or expired, or an identifier that matches several records.
조치 방법Read metadata.errorCode; rotate the replacement key, or disambiguate the identifier.
gone410
The record existed and has been removed. No reason is given, by design.
조치 방법Drop it from your mirror; /v1/changes reports it as removed.
quota-exhausted429
A plan ceiling is reached - requests (daily or monthly) or verifications. The message names which.
조치 방법Wait for Retry-After (the daily window resets at midnight UTC, the monthly one at X-Quota-Reset), or upgrade. The refused call is not charged.
rate-limited429
Too many requests too fast - the per-address flood throttle, or the public demo key's own limits, temporary blocks and in-flight cap.
조치 방법Wait Retry-After seconds, then slow down.
upstream-unavailable503
We could not meter or serve the request right now. Never served unmetered, never charged.
조치 방법Retry with exponential backoff.

버전 관리

v1에는 호환성을 깨는 변경이 없어요. v1 안에서는 경로, 필수 파라미터, 응답 필드가 바뀌지 않아요. 새 필드와 엔드포인트는 추가될 수 있으며, 먼저 변경 이력에 공지돼요. 버전 관리 방식

엔드포인트

Discovery

Titles

People

Changes

Account