Tài liệu API

Xác thực và base URL

URL cơ sở cho tất cả các yêu cầu là https://api.grokapiplatform.com/v1. Xác thực bằng cách truyền khóa API độc nhất của bạn trong Authorization header. Mọi yêu cầu phải bao gồm header này để xác minh số dư tài khoản của bạn và áp dụng giới hạn tốc độ.

Endpoint hoàn thành trò chuyện

Gửi các truy vấn văn bản đến POST /v1/chat/completions. ID mô hình cần sử dụng là "uncensored". Điểm cuối này xử lý các tương tác văn bản vào/văn bản ra tiêu chuẩn mà không yêu cầu cấu hình bổ sung cho việc sử dụng cơ bản.

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

Mô hình hoạt động với cửa sổ ngữ cảnh 100,000 token. Các token đầu vào và đầu cùng chia sẻ giới hạn này. Các yêu cầu vượt quá cửa sổ ngữ cảnh sẽ bị lỗi ngay lập tức.

Phản hồi dạng stream với SSE

Bật phát trực tiếp bằng cách đặt stream: true trong thân yêu cầu của bạn. Máy chủ trả về Sự kiện được gửi bởi máy chủ (SSE) với các cập nhật token tăng dần. Sử dụng điều này cho các hiển thị theo thời gian thực hoặc để giảm độ trễ cảm nhận.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.grokapiplatform.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)

Chi tiết sử dụng token xuất hiện trong chunk cuối cùng của luồng. Bạn có thể theo dõi tổng mức tiêu thụ cho mỗi yêu cầu mà không cần phân tích cú pháp từng delta trung gian.

Gọi hàm và công cụ

Định nghĩa các công cụ trong tools mảng và đặt tool_choice để kích hoạt các hành vi cụ thể. Mô hình hỗ trợ các mẫu sử dụng công cụ tiêu chuẩn tương thích với các SDK của OpenAI.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.grokapiplatform.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);

Sử dụng tool_choice: "auto" cho việc lựa chọn tự động hoặc chỉ định tên công cụ để thực thi bắt buộc. Điều này hoạt động liền mạch với mô hình không kiểm duyệt cho các nhiệm vụ suy luận phức tạp.

Chế độ JSON cho đầu ra có cấu trúc

Đặt response_format để {"type": "json_object"} để bắt buộc đầu ra JSON nghiêm ngặt. Điều này làm giảm lỗi phân tích khi tích hợp với các ứng dụng frontend hoặc quy trình dữ liệu.

Tham số và giới hạn

Điều chỉnh temperature, top_p, và seed để kiểm soát tính ngẫu nhiên. Đầu ra tối đa cho mỗi yêu cầu là 16,000 token. Lỗi như 401 cho biết khóa không hợp lệ, 402 có nghĩa là không đủ tín dụng trả trước, và 429 báo hiệu giới hạn tốc độ. Giới hạn là 300 yêu cầu mỗi phút mỗi khóa. Tín dụng không bao giờ hết hạn, vì vậy bạn có thể nạp tiền với USDT hoặc USDC bất cứ khi nào cần.

Phát trực tiếp

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)