Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tài liệu AVIS

Bắt đầu xây dựng với các mô hình mở.

Hướng dẫn sử dụngTài liệu APITích hợp

Bắt đầu chỉ trong vài phút

Thực hiện lệnh gọi API đầu tiên trong vòng chưa đầy 5 phút.

Hướng dẫn nhanh này trình bày các bước thiết lập cơ bản: tạo tài khoản, tạo API key và gửi request đầu tiên. Cùng một request được minh họa bằng nhiều ngôn ngữ để bạn bắt đầu với ngôn ngữ phù hợp với stack của mình.

Tùy chỉnh request đầu tiên của bạn

Cho biết bạn đang xây dựng gì để AI điều chỉnh hướng dẫn nhanh cho phù hợp.

GitBook Assistant

Sau khi gửi request đầu tiên, hãy xem các hướng dẫn thiết lập nâng cao và tài liệu API để tìm hiểu thêm về endpoint và tham số.

Bắt đầu Tài liệu API

1

Tạo API key

Thiết lập tài khoản, rồi tạo API key để thử nghiệm trên máy và dùng cho tích hợp đầu tiên.

Đăng nhập AVIS Platform

2

Nạp tiền vào số dư

Bước 1: Nhấn nút Top Up.

Bước 2: Chọn và tuỳ chỉnh phương thức thanh toán.

Bước 3: Điền đầy đủ thông tin bắt buộc.

Bước 4: Hoàn tất thanh toán.

3

Gửi request đầu tiên

Chọn một hướng dẫn API trong bộ tài liệu, thay YOUR_API_KEY bằng key của bạn rồi chạy ví dụ.

Tạo API key
Đăng nhập tại avis.net

Vào Settings → API Keys.

Nhấn Create key, đặt tên và lưu ở nơi an toàn — key gốc chỉ hiển thị một lần khi tạo (sau đó có thể xem lại từ cùng trang này).

Mỗi tài khoản có thể bị giới hạn số lượng API key. Tạo vượt quá giới hạn sẽ trả về 403 Forbidden.
## Bật / tắt streaming

| Giao diện | Cách stream | Cách nhận một response JSON duy nhất |
|---|---|---|
| OpenAI (`chat/completions`, `/responses`) | `"stream": true` trong body của request | `"stream": false` (mặc định) |
| OpenAI (`images/generations`) | `"stream": true` — chỉ có hiệu lực khi nhà cung cấp của mô hình được chọn hỗ trợ stream sự kiện hình ảnh; nếu không, request vẫn hoàn tất nhưng trả về dưới dạng một response JSON duy nhất | `"stream": false` (mặc định) |
| OpenAI (`videos`) | Không áp dụng — tạo video luôn là bất đồng bộ (gửi + poll), xem [Tương thích OpenAI](./openai-compatibility.md) | n/a |
| Anthropic (`messages`) | `"stream": true` trong body của request | `"stream": false` (mặc định) |
| Gemini | Gọi `models/{model}:streamGenerateContent` thay vì `models/{model}:generateContent` | Gọi `:generateContent` |

Mọi response dạng stream đều được gửi với `Content-Type: text/event-stream`, `Cache-Control: no-cache, no-transform` và `Connection: keep-alive`.
## Endpoints

| Method | Path | Mô tả |
| --- | --- | --- |
| GET | `/api/compat/v1/usage` | Liệt kê các bản ghi generation từ bảng `generations` |

Xác thực: `Authorization: Bearer <jwt>` hoặc `x-api-key`.

## GET /api/compat/v1/usage

Các trường query:

| Trường | Kiểu | Bắt buộc | Ghi chú |
| --- | --- | --- | --- |
| `offset` | `number` | Không | Mặc định `0` |
| `limit` | `number` | Không | Mặc định `20` |

Cấu trúc response:

| Trường | Kiểu |
| --- | --- |
| `results[]` | Mảng các bản ghi generation |
| `results[].id` | `string` |
| `results[].userId` | `string` |
| `results[].apiKeyId` | `string \| undefined` |
| `results[].modality` | `"text" \| "image" \| "video" \| "audio"` |
| `results[].model` | `string` |
| `results[].status` | `"succeeded" \| "failed" \| "aborted" \| "cancelled"` |
| `results[].request` | `object \| undefined` |
| `results[].usage` | `object \| undefined` |
| `results[].usdCost` | `number \| undefined` |
| `results[].durationMs` | `number \| undefined` |
| `results[].createdAt` | `datetime` |
| `total` | `number` |
| `offset` | `number` |
| `limit` | `number` |

Endpoint này hiện chỉ hỗ trợ phân trang và trả về các bản ghi generation dạng compat.

## Lưu ý về dữ liệu `generations`

Endpoint này trả về một **bản ghi sử dụng rút gọn**, bao gồm payload `request` và `usdCost`.

## Tham khảo: `usage` theo loại dữ liệu (từ `generations`)

Dựa trên các bản ghi thực tế hiện tại, payload `usage` khác nhau tùy theo loại dữ liệu.

### Văn bản

Các trường thường gặp:

| Trường | Kiểu |
| --- | --- |
| `usage.promptTokens` | `number` |
| `usage.completionTokens` | `number` |
| `usage.totalTokens` | `number` |

### Hình ảnh

Các trường thường gặp:

| Trường | Kiểu |
| --- | --- |
| `usage.generatedImages` | `number` |
| `usage.inputTokens` | `number` |
| `usage.outputTokens` | `number` |
| `usage.totalTokens` | `number` |

### Video

Các trường thường gặp:

| Trường | Kiểu |
| --- | --- |
| `usage.completionTokens` | `number` |
| `usage.totalTokens` | `number` |

Các key chính xác trong `usage` có thể khác nhau tùy nhà cung cấp/mô hình.

Base URL

Chuyển đổi một ứng dụng hiện có

POST /chat/completions

POST /images/generations

POST /videos — job bất đồng bộ

Base URL

Chuyển đổi một ứng dụng hiện có

Bạn không cần thay đổi phần nào khác trong tích hợp Anthropic hiện có.

Endpoints

Method
Path
Streaming
Mô tả

HEAD

/api/anthropic

—

Kiểm tra kết nối (không cần xác thực)

GET

/api/anthropic/v1/models

—

Liệt kê các mô hình khả dụng

POST

/api/anthropic/v1/messages

✅

Messages API

Nếu request có header anthropic-version hoặc anthropic-beta, các header này sẽ được chuyển tiếp đến nhà cung cấp upstream. Xem phần Xác thực.

POST /messages

Base URL

SDK @google/genai tự động thêm /v1beta vào baseUrl. Hãy truyền https://api.avis.net/api/gemini, không phải .../api/gemini/v1beta, để tránh lặp đường dẫn.

Chuyển đổi một ứng dụng hiện có

Model ID có tiền tố google/, ví dụ google/gemini-2.0-flash.

Endpoints

Method
Path
Streaming
Mô tả

HEAD

/api/gemini

—

Kiểm tra kết nối (không cần xác thực)

GET

/api/gemini/v1beta/models

—

Liệt kê các mô hình khả dụng

POST

/api/gemini/v1beta/models/{model}:generateContent

—

Tạo nội dung

POST

/api/gemini/v1beta/models/{model}:streamGenerateContent

✅

Tạo nội dung, dạng stream

POST /models/{model}:generateContent

POST /models/{model}:streamGenerateContent

Tìm hiểu thêm về nền tảng dành cho nhà phát triển

Đọc các hướng dẫn để tìm hiểu cách sử dụng nền tảng dành cho nhà phát triển và tích hợp nền tảng vào stack của bạn.

Tích hợp Tài liệu API

Last updated

Was this helpful?