Tài liệu tham khảo API chỉ có bằng tiếng Anh.
https://api.
Mọi điểm cuối của v1, kèm theo tham số, ví dụ yêu cầu và phản hồi, cùng các lỗi có thể trả về. Phần mô tả điểm cuối được viết bằng tiếng Anh.
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.
Authorization: Bearer $WAMBESHA_API_KEYVới những điểm cuối chấp nhận khóa demo công khai, đoạn mã “Dùng thử” của điểm cuối đó đã chứa sẵn khóa này nên có thể chạy ngay như vậy; mọi đoạn mã khác đều cần khóa của riêng bạn. Khóa demo chỉ dùng để dùng thử API: khóa được thay đổi hằng ngày, có thể bị tắt bất cứ lúc nào và tuyệt đối không được dùng trong môi trường vận hành thực tế. Hãy dùng khóa của riêng bạn cho mọi thứ bạn xây dựng.
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.
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.
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).
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.
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.
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).
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.
Mọi lỗi đều có cùng một phần thân: trạng thái HTTP, một mã ổn định để bạn rẽ nhánh xử lý, một thông báo dành cho người đọc và các lỗi trường khi có giá trị sai. Để chỉ rõ một yêu cầu khi liên hệ với chúng tôi, hãy dùng tiêu đề phản hồi X-Request-ID của yêu cầu đó.
Phản hồi đã ghi lại
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
v1 không bao giờ phá vỡ tương thích: đường dẫn, tham số bắt buộc và các trường phản hồi không thay đổi trong v1. Có thể bổ sung trường và điểm cuối mới, và chúng sẽ được thông báo trước trong nhật ký thay đổi. Cách hoạt động của việc lập phiên bản
/v1/discover filters on. Spends no verification.missing rather than failing the call. Spends no verification.