Module thông tin công cộng

Nên sử dụng HTTPS trong môi trường sản xuất để bảo mật mã thông báo xác thực. HTTP chỉ được khuyến nghị cho môi trường phát triển.

Cung cấp thông tin hệ thống có thể truy cập mà không cần xác thực hoặc có đặc quyền thấp, bao gồm danh sách model, chi tiết giá cả, nội dung thông báo, v.v. Hỗ trợ hiển thị đa ngôn ngữ và cấu hình động. Trang chủ giao diện người dùng và thị trường mô hình chủ yếu dựa vào các giao diện này để tìm nạp dữ liệu hiển thị.

🔐 Không cần xác thực

Nhận nội dung thông báo

• Tên giao diện: Nhận nội dung thông báo
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/notice
• Yêu cầu xác thực: Công khai
• Tóm tắt chức năng: Truy xuất nội dung thông báo hệ thống, hỗ trợ định dạng Markdown

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/notice', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "message": "",
  "data": "# System Announcement\n\nWelcome88APIsystem！"
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to get announcement"
}

🧾 Mô tả trường:

data (String): Nội dung thông báo, hỗ trợ định dạng Markdown

###Giới thiệu về thông tin trang

• Tên giao diện: Giới thiệu về thông tin trang
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/about
• Yêu cầu xác thực: Công khai
• Tóm tắt chức năng: Truy xuất nội dung tùy chỉnh cho trang Giới thiệu

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/about', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "message": "",
  "data": "# about Us\n\n88APIis a powerfulAIgateway system..."
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to get information about"
}

🧾 Mô tả trường:

data (String): Về nội dung trang, hỗ trợ định dạng Markdown hoặc liên kết URL

Nội dung tùy chỉnh của trang chủ

• Tên giao diện: Nội dung tùy chỉnh của trang chủ
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/home_page_content
• Yêu cầu xác thực: Công khai
• Tóm tắt chức năng: Truy xuất nội dung tùy chỉnh cho trang chủ, có thể là văn bản Markdown hoặc URL iframe

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/home_page_content', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "message": "",
  "data": "# Welcome88API\n\nThis is a powerfulAIgateway system..."
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to obtain home page content"
}

🧾 Mô tả trường:

data (Chuỗi): Nội dung trang chủ, có thể là văn bản Markdown hoặc liên kết URL bắt đầu bằng "https://"

Cấu hình tỷ lệ mô hình

• Tên giao diện: Cấu hình tỷ lệ mô hình
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/ratio_config
• Yêu cầu xác thực: Công khai
• Tóm tắt chức năng: Truy xuất thông tin cấu hình tỷ lệ mô hình công khai để đồng bộ hóa bởi các hệ thống ngược dòng

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/ratio_config', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "data": {
    "model_ratio": {
      "gpt-3.5-turbo": 1.0,
      "gpt-4": 15.0,
      "claude-3-sonnet": 3.0
    },
    "completion_ratio": {
      "gpt-3.5-turbo": 1.0,
      "gpt-4": 1.0
    },
    "model_price": {
      "gpt-3.5-turbo-instruct": 0.002
    }
  }
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to obtain magnification configuration"
}

🧾 Mô tả trường:

data (Đối tượng): Thông tin cấu hình tỷ lệ

• model_ratio (Object): Ánh xạ tỷ lệ mô hình, trong đó khóa là tên mô hình và giá trị là giá trị số tỷ lệ
• completion_ratio (Object): Ánh xạ tỷ lệ hoàn thành
• model_price (Đối tượng): Ánh xạ giá model, trong đó key là tên model và giá trị là giá (USD)

Thông tin về giá và gói

• Tên giao diện: Thông tin về giá và gói
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/pricing
• Yêu cầu xác thực: Ẩn danh/Người dùng
• Tóm tắt chức năng: Truy xuất thông tin về giá mô hình, tỷ lệ nhóm và các nhóm có sẵn

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/pricing', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_token', // Optional, logged-in users get more detailed information
    'New-Api-User': 'your_user_id' // Optional
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "data": [
    {
      "model_name": "gpt-3.5-turbo",
      "enable_group": ["default", "vip"],
      "model_ratio": 1.0,
      "completion_ratio": 1.0,
      "model_price": 0.002,
      "quota_type": 1,
      "description": "GPT-3.5 TurboModel",
      "vendor_id": 1,
      "supported_endpoint_types": [1, 2]
    }
  ],
  "vendors": [
    {
      "id": 1,
      "name": "OpenAI",
      "description": "OpenAIofficial model",
      "icon": "openai.png"
    }
  ],
  "group_ratio": {
    "default": 1.0,
    "vip": 0.8
  },
  "usable_group": {
    "default": "Default grouping",
    "vip": "VIPGroup"
  },
  "supported_endpoint": {
    "1": {"method": "POST", "path": "/v1/chat/completions"},
    "2": {"method": "POST", "path": "/v1/embeddings"}
  },
  "auto_groups": ["default"]
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to obtain pricing information"
}

🧾 Mô tả trường:

• data (Array): Danh sách thông tin giá model

• model_name (String): Tên model

• enable_group (Array): Danh sách nhóm có sẵn

• model_ratio (Số): Tỷ lệ mẫu

• completion_ratio (Số): Tỷ lệ hoàn thành

• model_price (Số): Giá model (USD)

• quota_type (Số): Loại thanh toán, 0=Thanh toán theo tỷ lệ, 1=Thanh toán theo giá

• description (String): Mô tả model

• vendor_id (Số): ID nhà cung cấp

• supported_endpoint_types (Array): Các loại endpoint được hỗ trợ

• vendors (Array): Danh sách thông tin nhà cung cấp

• id (Số): ID nhà cung cấp

• name (String): Tên nhà cung cấp

• description (String): Mô tả nhà cung cấp

• icon (String): Biểu tượng nhà cung cấp

• group_ratio (Object): Ánh xạ tỷ lệ nhóm

• usable_group (Object): Ánh xạ nhóm có thể sử dụng

• supported_endpoint (Object): Thông tin điểm cuối được hỗ trợ

• auto_groups (Array): Danh sách nhóm tự động

🔐 Yêu cầu xác thực người dùng

Nhận danh sách mô hình có sẵn ở giao diện người dùng

• Tên giao diện: Nhận danh sách mô hình có sẵn ở giao diện người dùng
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/models
• Yêu cầu xác thực: Người dùng
• Tóm tắt chức năng: Truy xuất danh sách các mô hình AI mà người dùng hiện tại có thể truy cập, được sử dụng để hiển thị Bảng điều khiển giao diện người dùng

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/models', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "data": {
    "1": ["gpt-3.5-turbo", "gpt-4"],
    "2": ["claude-3-sonnet", "claude-3-haiku"]
  }
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Unauthorized access"
}

🧾 Mô tả trường:

data (Đối tượng): Ánh xạ từ ID kênh tới danh sách model

• Key (String): ID kênh
• Value (Array): Danh sách tên model được kênh này hỗ trợ