Tổng quan về API
Mọi endpoint mà gateway cung cấp, định dạng mà từng endpoint sử dụng và dữ liệu trả về.
Ba endpoint. Hai định dạng yêu cầu. Một khóa.
| Phương thức | Đường dẫn | Định dạng | Mục đích |
|---|---|---|---|
| POST | /v1/messages | Anthropic Messages | Hoàn thành hội thoại, cấu trúc bao bọc Anthropic |
| POST | /v1/chat/completions | OpenAI Chat Completions | Hoàn thành hội thoại, cấu trúc bao gói OpenAI |
| GET | /v1/models | Danh sách theo kiểu OpenAI | Các ID mô hình mà khóa của bạn có thể gọi |
Mô tả ở định dạng máy có thể đọc được công bố tại /openapi.json, và bản tóm tắt toàn bộ trang web bằng văn bản thuần túy tại /llms.txt và /llms-full.txt.
Chọn endpoint
Chúng cung cấp quyền truy cập vào cùng các mô hình với cùng mức giá. Hãy chọn theo định dạng mà ứng dụng khách của bạn đã gửi — đừng tự chuyển đổi định dạng.
| Endpoint | Header xác thực | Cấu trúc phản hồi | Truyền dữ liệu theo luồng |
|---|---|---|---|
/v1/messages | x-api-key hoặc Bearer | content[] mảng + usage | SSE, content_block_delta sự kiện |
/v1/chat/completions | Bearer | choices[].message.content | SSE, choices[].delta.content các đoạn dữ liệu |
Các cấu trúc truyền luồng khác nhau và không thể dùng thay thế cho nhau. Một ứng dụng khách được viết cho
choices[].delta.content sẽ không đọc được bất kỳ dữ liệu nào từ luồng Messages. Xem Truyền dữ liệu theo luồng.Các header dùng chung
| Header | Áp dụng cho | Ghi chú |
|---|---|---|
content-type: application/json | cả hai yêu cầu POST | Bắt buộc |
x-api-key | Messages | Kiểu Anthropic |
Authorization: Bearer | cả hai | Kiểu OpenAI; Messages cũng chấp nhận |
anthropic-version: 2023-06-01 | Messages | Được các SDK Anthropic thiết lập tự động |
accept: text/event-stream | cả hai | Được các SDK thiết lập khi stream là true |