Bắt đầu nhanh: Tích hợp API Bạn Gái AI

URL cơ sở và Xác thực

API của chúng tôi tuân theo tiêu chuẩn chat-completions của OpenAI, giúp việc tích hợp trở nên đơn giản cho các khách hàng hiện có. Bạn phải bao gồm khóa API của mình trong tiêu đề Authorization của mọi yêu cầu. URL cơ sở cho tất cả các endpoint là https://api.roleplayapi.com/v1. Khi sử dụng SDK chính thức, hãy cập nhật cấu hình base_url để trỏ đến địa chỉ này và cung cấp khóa của bạn dưới dạng api_key. Cấu hình này đảm bảo các yêu cầu của bạn đến được endpoint không kiểm duyệt chuyên dụng của chúng tôi mà không cần thay đổi logic tiêu chuẩn của bạn.

Gửi Hoàn Thành

Khởi tạo cuộc trò chuyện bằng cách gửi yêu cầu POST đến /v1/chat/completions. Định danh mô hình là uncensored. Bạn có thể truyền bất kỳ số lượng tin nhắn nào trong mảng messages để thiết lập ngữ cảnh hoặc bắt đầu một cuộc hội thoại mới. Phản hồi chứa đầu ra văn bản của mô hình, mà bạn có thể truyền phát hoặc phân tích cú pháp dưới dạng đối tượng JSON. Endpoint này xử lý tương tác cốt lõi vào-ra văn bản cần thiết cho các ứng dụng dựa trên nhân vật.

Copycurl https://api.roleplayapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Tích hợp SDK Python

Sử dụng thư viện Python openai chính thức để tương tác với API với ít mã boilerplate nhất. Cấu hình client với URL cơ sở của chúng tôi và khóa API của bạn. Sau đó, gọi chat.completions.create với ID mô hình uncensored. Cách tiếp cận này tận dụng các gợi ý kiểu và cơ chế xử lý lỗi hiện có, cho phép bạn tập trung vào logic ứng dụng của mình thay vì phân tích cú pháp HTTP. Đối tượng phản hồi cung cấp quyền truy cập trực tiếp vào nội dung được tạo.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.roleplayapi.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Tích hợp SDK Node.js

Đối với các dự án JavaScript và TypeScript, SDK Node.js của OpenAI cung cấp giao diện sạch sẽ cho các cuộc gọi API. Khởi tạo client với URL cơ sở tùy chỉnh và khóa bí mật của bạn. Gọi endpoint hoàn thành cuộc trò chuyện bằng mô hình uncensored. Phương pháp này lý tưởng cho các máy chủ web hoặc hàm biênEdge nơi bạn cần quản lý các yêu cầu không đồng bộ một cách hiệu quả. SDK xử lý tự động việc tuần tự hóa và phân tích cú pháp tải trọng JSON.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.roleplayapi.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

Bật Truyền phát

Giảm độ trễ cảm nhận bằng cách kích hoạt các sự kiện do máy chủ gửi (SSE). Đặt tham số stream thành true trong yêu cầu của bạn. API sẽ trả về một luồng các chunk thay vì một phản hồi hoàn chỉnh duy nhất. Điều này đặc biệt hữu ích cho các giao diện trò chuyện nơi người dùng mong đợi phản hồi nhân vật ngay lập tức. Bạn có thể xử lý từng chunk khi nó đến, cập nhật giao diện người dùng theo từng bước. Luồng kết thúc khi mô hình hoàn tất việc tạo chuỗi token.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Giới hạn, Lỗi và Ngữ cảnh

Các yêu cầu của bạn chịu giới hạn tốc độ là 300 yêu cầu mỗi phút trên mỗi khóa. Nếu bạn vượt quá giới hạn này, API sẽ trả về mã trạng thái 429. Lỗi xác thực dẫn đến lỗi 401, trong khi tín dụng trả trước không đủ sẽ kích hoạt lỗi 402. Cửa sổ ngữ cảnh hỗ trợ tối đa 100.000 token cho prompt và phần hoàn thành kết hợp. Nếu bạn cần kiểm tra các mô hình có sẵn, hãy gửi yêu cầu GET đến /v1/models. Đảm bảo thân yêu cầu của bạn không vượt quá 8 MB.