Tài liệu hướng dẫn tích hợp API

Tìm hiểu cách tích hợp hệ sinh thái AI của Kira vào các ứng dụng, SDK, và phần mềm của bên thứ ba.

1. Giới thiệu nền tảng Kira AI

Kira AI là cổng kết nối API tập trung, bảo mật và có hiệu năng cao, kết nối trực tiếp đến các dòng mô hình ngôn ngữ lớn (LLM) hàng đầu hiện nay. Nền tảng được tối ưu hóa chi phí vượt trội, cung cấp giải pháp kết nối White-Label thuần khiết giúp nhà phát triển dễ dàng tích hợp trí tuệ nhân tạo đa dạng vào ứng dụng của mình mà không bị giới hạn bởi một nhà cung cấp đơn lẻ.

Hệ thống hỗ trợ 2 phương thức giao tiếp chính: Trò chuyện trực tuyến (Web Client) trực tiếp trên trình duyệt và Cổng API kết nối ngoài tương thích hoàn toàn 100% với định dạng chuẩn OpenAI, giúp dễ dàng tích hợp và mở rộng các mô hình AI thông minh vào các phần mềm viết sẵn.

Tải về Agent Skill cho IDE (Cursor / VS Code / Cline / Roo Code)

Kira AI cung cấp tệp cấu hình Skill tích hợp sẵn giúp các trợ lý AI lập trình của bạn (như Cursor, Cline, Roo Code, Claude Dev,...) hiểu rõ cấu trúc API, các model được hỗ trợ, và sinh mã kết nối chuẩn xác nhất.

Tải về file cấu hình Skill (kira-ai-api.zip)

2. Quản lý API key & xác thực

Để tích hợp Kira AI vào các công cụ như Cursor, LibreChat, NextChat, OpenWebUI, Obsidian,... bạn cần tạo API Key tại tab Quản lý API key trong màn hình Console của tài khoản.

Thông số cấu hình kết nối chung:
  • - API Base URL: https://kiraai.vn/api/v1
  • - Authorization Header: Bearer KIRA_API_KEY_CUA_BAN
  • - Định danh Model: kira-mini-1.0 (Miễn phí), kira-3.5-pro, kira-3.5-flash, kira-2.5-pro, kira-2.5-flash, kira-3.0-image, kira-2.0-image, kira-3.0-video, kira-3.0-video-flash, kira-3.0-flash-tts, kira-2.0-flash-tts

3. Hướng dẫn sử dụng chat API

API chat hỗ trợ trò chuyện, phân tích dữ liệu, sinh code tự động. Bạn có thể sử dụng các thư viện SDK OpenAI của bất cứ ngôn ngữ nào bằng cách đổi baseURL.

Ví dụ kết nối bằng Node.js / OpenAI SDK:
import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://kiraai.vn/api/v1", 
  apiKey: "YOUR_KIRA_API_KEY" 
});

const completion = await openai.chat.completions.create({
  model: "kira-3.5-flash",
  messages: [
    { role: "system", content: "You are a helpful assistant." },
    { role: "user", content: "Xin chào Kira AI!" }
  ]
});

console.log(completion.choices[0].message.content);

4. Gửi hình ảnh cho model phân tích (Vision)

Các model hỗ trợ vision cho phép bạn gửi hình ảnh kèm theo tin nhắn để AI phân tích, mô tả hoặc trích xuất thông tin. Kira AI hỗ trợ đầy đủ định dạng image_url theo chuẩn OpenAI, bao gồm cả URL công khai và base64.

Gửi ảnh qua URL:
const completion = await openai.chat.completions.create({
  model: "kira-3.5-flash",
  messages: [
    {
      role: "user",
      content: [
        { type: "text", text: "Mô tả chi tiết hình ảnh này" },
        {
          type: "image_url",
          image_url: {
            url: "https://example.com/photo.jpg"
          }
        }
      ]
    }
  ]
});

console.log(completion.choices[0].message.content);
Gửi ảnh dạng base64:
import fs from "fs";

// Đọc file ảnh và chuyển sang base64
const imageBuffer = fs.readFileSync("./photo.jpg");
const base64Image = imageBuffer.toString("base64");

const completion = await openai.chat.completions.create({
  model: "kira-3.5-flash",
  messages: [
    {
      role: "user",
      content: [
        { type: "text", text: "Ảnh này chụp gì?" },
        {
          type: "image_url",
          image_url: {
            url: `data:image/jpeg;base64,${base64Image}`
          }
        }
      ]
    }
  ]
});
Ví dụ Python:
import base64
from openai import OpenAI

client = OpenAI(
    base_url="https://kiraai.vn/api/v1",
    api_key="YOUR_KIRA_API_KEY"
)

# Cách 1: Gửi URL ảnh
response = client.chat.completions.create(
    model="kira-3.5-flash",
    messages=[
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "Mô tả hình ảnh này"},
                {
                    "type": "image_url",
                    "image_url": {
                        "url": "https://example.com/photo.jpg"
                    }
                }
            ]
        }
    ]
)

print(response.choices[0].message.content)

5. Hướng dẫn sử dụng image generation API

Tạo hình ảnh nghệ thuật chất lượng cao từ mô tả văn bản thông qua endpoint /images/generations.

Tham số tạo ảnh:
  • - Mô hình: kira-3.0-image (tốc độ cao, cực nhanh) hoặc kira-2.0-image (ổn định lâu dài)
  • - Tỷ lệ ảnh (aspect_ratio): "1:1", "16:9", "9:16", "4:3", "3:4"
Ví dụ tạo ảnh bằng cURL:
curl -X POST https://kiraai.vn/api/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_KIRA_API_KEY" \
  -d '{
    "model": "kira-3.0-image",
    "prompt": "A beautiful cyber-punk city in rain, neon light reflections, high resolution",
    "aspect_ratio": "16:9"
  }'

6. Hướng dẫn sử dụng text to speech API (TTS)

API Text-to-Speech (TTS) của Kira AI cho phép bạn chuyển đổi văn bản viết thành các tệp âm thanh giọng nói tự nhiên, chất lượng cao. API tương thích hoàn toàn với định dạng chuẩn OpenAI tại endpoint /audio/speech.

Tham số cấu hình chính:
  • - API Endpoint: POST https://kiraai.vn/api/v1/audio/speech
  • - Tham số body bắt buộc: input (văn bản cần chuyển sang âm thanh), model (kira-3.0-flash-tts: tối ưu ngữ điệu & phát âm tiếng Việt chuẩn phòng thu hoặc kira-2.0-flash-tts: tối ưu tốc độ phản hồi), voice (tên giọng đọc).
  • - Giọng đọc hỗ trợ (Kira voices): Kore, Fenrir, Puck, Charon, Aoede.
  • * Hỗ trợ tự động map từ các giọng chuẩn của OpenAI: alloy (Kore), echo (Fenrir), fable (Puck), onyx (Charon), nova (Aoede).
Ví dụ gọi API TTS bằng cURL:
curl -X POST https://kiraai.vn/api/v1/audio/speech \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_KIRA_API_KEY" \
  -d '{
    "model": "kira-3.0-flash-tts",
    "input": "Chào mừng bạn đến với hệ sinh thái trí tuệ nhân tạo Kira AI.",
    "voice": "alloy"
  }' --output output.mp3
Ví dụ kết nối bằng Node.js / OpenAI SDK:
import fs from "fs";
import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://kiraai.vn/api/v1",
  apiKey: "YOUR_KIRA_API_KEY"
});

const mp3 = await openai.audio.speech.create({
  model: "kira-3.0-flash-tts",
  voice: "alloy",
  input: "Chào mừng bạn đến với hệ sinh thái trí tuệ nhân tạo Kira AI."
});

const buffer = Buffer.from(await mp3.arrayBuffer());
await fs.promises.writeFile("output.mp3", buffer);

7. Hướng dẫn sử dụng video generation API

Kira AI hỗ trợ tạo video bằng trí tuệ nhân tạo thông qua các mô hình:

Quá trình xử lý video diễn ra bất đồng bộ thông qua mô hình Operation:

Quy trình 2 bước:
1. Gửi POST đến /videos/generations để nhận về operation ID (UUID).
2. Gửi GET đến /videos/operations/:uuid định kỳ để kiểm tra trạng thái và nhận link tải video khi hoàn tất.

8. Hướng dẫn cấu hình Kira AI cho Codex (CLI & Desktop app)

Codex (bao gồm Codex CLI và Codex Desktop app) là trợ lý lập trình chuyên sâu của OpenAI, cho phép đọc hiểu toàn bộ workspace, phân tích codebase, tự động sinh code, tạo và chỉnh sửa file, cũng như thực thi lệnh shell trực tiếp.

Kira AI cung cấp cổng kết nối chuẩn OpenAI Responses API (endpoint /api/v1/responses), hỗ trợ đầy đủ Server-Sent Events (SSE) streaming và cơ chế tool calling native/custom, giúp Codex hoạt động mượt mà và tự động thao tác file chính xác 100%.

Bước 1: Cấu hình tệp config.toml của Codex

Mở tệp cấu hình của Codex tại đường dẫn ~/.codex/config.toml (trên macOS / Linux: ~/.codex/config.toml, trên Windows: %USERPROFILE%\.codex\config.toml) và thêm cấu hình nhà cung cấp Kira AI:

Cấu hình mẫu ~/.codex/config.toml:
# Khai báo nhà cung cấp mặc định (viết thường toàn bộ: "kiraai")
model_provider = "kiraai"
model = "gpt-5.6-sol" # Khuyên dùng: gpt-5.6-sol, gpt-5.6-luna hoặc gpt-oss-120b
model_reasoning_effort = "medium"
approval_policy = "never"

# Định nghĩa provider Kira AI kết nối qua Responses API
[model_providers.kiraai]
name = "kiraai"
base_url = "https://kiraai.vn/api/v1"
wire_api = "responses"
env_key = "OPENAI_API_KEY"

# Cấp quyền tin cậy cho thư mục dự án (để Codex tự động tạo file và chạy lệnh shell)
[projects."/duong/dan/den/thu/muc/du/an"]
trust_level = "trusted"
Bước 2: Cài đặt khóa API key (chọn 1 trong 2 cách)

Lấy API key tại trang quản trị Kira AI (dạng kira_...) và lưu vào hệ thống:

Cách 1: Đặt biến môi trường qua terminal (macOS / Linux):
# Thêm biến môi trường vào ~/.zshrc (hoặc ~/.bashrc)
echo 'export OPENAI_API_KEY="kira_api_key_cua_ban"' >> ~/.zshrc
source ~/.zshrc
Cách 2: Lưu trực tiếp vào tệp auth.json của Codex Desktop:
// Mở tệp ~/.codex/auth.json và dán nội dung:
{
  "OPENAI_API_KEY": "kira_api_key_cua_ban"
}
Các lưu ý quan trọng để tránh lỗi:
Tên provider (case-sensitive): Giá trị model_provider = "kiraai" phải viết thường 100%, khớp chính xác với tiêu đề section [model_providers.kiraai].
Chế độ phê duyệt (Approval policy): Thiết lập approval_policy = "never" để Codex tự động thực thi các công cụ (tạo file, chạy lệnh terminal) mà không bị treo do chờ phê duyệt thủ công.
Quyền thư mục (Project trust): Thêm mục [projects."/duong/dan/thu/muc"] với trust_level = "trusted" cho thư mục bạn đang làm việc để mở khóa toàn bộ quyền thao tác file.
Khởi động lại Codex: Luôn khởi động lại ứng dụng Codex sau khi cập nhật file config.toml hoặc thêm API key.

9. Hướng dẫn User Management API (quản trị tài khoản)

Bộ RESTful Management API v1 cho phép lập trình viên tự động hóa việc kiểm tra số dư VND/Token, tạo & quản lý khóa API Key, và tra cứu chi tiết Lịch sử sử dụng tiêu thụ token một cách nhanh chóng.

Quy tắc xác thực bảo mật (Authentication):
- JWT Token (Đăng nhập qua /api/auth/login): Có toàn quyền (bao gồm Tạo/Sửa/Xóa API Key).
- API Key phụ (kira_...): Dùng đọc số dư (/profile), tra cứu lịch sử tiêu dùng (/usage/logs) và gọi AI.
8.1 Lấy thông tin tài khoản & số dư (Profile & balance):

Gửi yêu cầu GET đến /api/v1/user/profile để nhận số dư VND, số dư Token, hạn mức ngày và lượng token đã dùng trong ngày:

Ví dụ lấy Profile bằng cURL:
curl -X GET https://kiraai.vn/api/v1/user/profile \
  -H "Authorization: Bearer YOUR_API_KEY_HOAC_JWT"
8.2 Tra cứu lịch sử sử dụng tiêu thụ (Usage logs):

Gửi yêu cầu GET đến /api/v1/user/usage/logs (hỗ trợ tham số page, limit, key_id, model) để lấy danh sách tiêu tốn token tương tự bảng lịch sử trên website:

Ví dụ tra cứu Lịch sử sử dụng bằng JavaScript (Fetch):
const res = await fetch('https://kiraai.vn/api/v1/user/usage/logs?page=1&limit=20', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await res.json();
console.log(data.logs); // Mảng chi tiết: timestamp, model, prompt_tokens, completion_tokens, tokens_used, cost_vnd...
8.3 Quản lý API key (tạo, sửa, xóa):

- Danh sách key: GET /api/v1/user/keys
- Tạo key mới: POST /api/v1/user/keys (Body: {"name": "Key Zalo Bot"})
- Sửa tên / Đổi trạng thái: PATCH /api/v1/user/keys/:id (Body: {"status": "inactive"})
- Xóa key: DELETE /api/v1/user/keys/:id

Ví dụ tạo API Key mới bằng cURL (Cần JWT Token):
curl -X POST https://kiraai.vn/api/v1/user/keys \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "App Mobile Key"}'

10. Tài liệu API bổ trợ (mô hình & giọng đọc)

Kira AI cung cấp các API bổ trợ hữu ích giúp bạn truy vấn động Danh sách mô hình đang hoạt động và danh sách giọng đọc của hệ thống Text-to-Speech (TTS).

9.1 Lấy danh sách mô hình (models list):

Gửi yêu cầu GET đến endpoint /models để nhận về mảng chứa cấu hình chi tiết của tất cả mô hình bao gồm: ID, tên hiển thị, thể loại, trạng thái và đơn giá:

Ví dụ gọi API lấy danh sách mô hình bằng cURL:
curl -X GET https://kiraai.vn/api/v1/models \
  -H "Authorization: Bearer YOUR_KIRA_API_KEY"
9.2 Lấy danh sách giọng đọc (TTS voices list):

Gửi yêu cầu GET đến endpoint /audio/voices để nhận về danh sách giọng đọc được hỗ trợ cùng thông tin mô tả chi tiết ngôn ngữ, giới tính:

Ví dụ gọi API lấy danh sách giọng đọc bằng cURL:
curl -X GET https://kiraai.vn/api/v1/audio/voices