Tham chiếu API

Bắt đầu, xác thực, endpoint và mã lỗi

Bắt đầu

RoboVAI tương thích với client chính thức của OpenAI và Anthropic — chỉ cần thay base_url và api_key.

Base URL

https://api.robovai.com

Endpoint dưới đây được trả về bởi gateway hiện tại; hãy điền vào trường base_url / endpoint API của client.

Client tương thích OpenAI dùng https://api.robovai.com/api/open/v1; client tương thích Anthropic (vd. Claude Code) dùng https://api.robovai.com/api/plan.

Tạo khóa trong “Bảng điều khiển → Khóa API”, sau đó điền vào trường api_key của client.

Xác thực

Mọi yêu cầu đều gửi khóa API qua HTTP header:

apiDocs.auth.header

Định dạng khóa: khóa đăng ký bắt đầu bằng sub_, khóa trả theo lượng dùng bắt đầu bằng api_.

Không hardcode khóa trong code frontend hay repo công khai; đặt lại ngay trong bảng điều khiển nếu bị lộ.

Danh sách endpoint

Tương thích OpenAI

/api/open/v1

https://api.robovai.com/api/open/v1

Tương thích API Chat/Completions của OpenAI — cho ChatBox, OpenCat, v.v. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1

Endpoint theo modalitas

Các endpoint được nhóm theo modalitas đầu vào/đầu ra. Chat văn bản là đồng bộ/streaming; tạo ảnh trả về URL đồng bộ; tạo video là bất đồng bộ (gửi rồi polling). Mọi body request đều được chuyển tiếp tới provider thượng nguồn — chỉ model là bắt buộc; các trường khác tuân theo spec của model tương ứng.

Endpoint bất đồng bộ: gửi để lấy task_id, rồi polling kết quả.

Chat văn bản

Chat văn bản đồng bộ hoặc streaming, tương thích cả hai giao thức OpenAI và Anthropic.

POSTChat Completions

https://api.robovai.com/api/open/v1/chat/completions

Tương thích OpenAI, hỗ trợ streaming. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/chat/completions

POSTMessages (Anthropic)

https://api.robovai.com/api/plan/v1/messages

Tương thích Anthropic, cho Claude Code v.v. Đường dẫn đầy đủ: https://api.robovai.com/api/plan/v1/messages

POSTResponses

Mã lỗi

Trạng thái	Ý nghĩa	Gợi ý
400 Bad Request	Tham số yêu cầu sai	Kiểm tra body, tên model và định dạng tham số.
401 Unauthorized	Thiếu hoặc sai khóa	Đảm bảo header Authorization mang khóa API hợp lệ.
402 Payment Required	Số dư không đủ hoặc hết hạn mức	Nạp tiền trong bảng điều khiển hoặc đổi khóa.
403 Forbidden	Không có quyền truy cập model	Xác nhận gói của khóa có chứa model mục tiêu.
404 Not Found	Không tìm thấy model hoặc endpoint	Kiểm tra ID model và đường dẫn endpoint.
429 Too Many Requests	Giới hạn tần suất	Giảm tần suất yêu cầu hoặc thử lại sau.

POSTEmbeddings

https://api.robovai.com/api/open/v1/embeddings

Vector hóa văn bản. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/embeddings

Trường	Kiểu	Bắt buộc	Mô tả
model	string	Có	ID model.
messages	array	Có	Mảng tin nhắn với role và content.
stream	boolean	Không	Streaming response, mặc định false.
temperature	number	Không	Nhiệt độ sampling, 0–2, mặc định 1.
max_tokens	integer	Không	Số token tối đa được tạo.
tools

Ví dụ request

apiDocs.modalities.text.request

Ví dụ response

apiDocs.modalities.text.response

Tạo ảnh

Trả về URL ảnh đã tạo đồng bộ (OpenAI gpt-image qua /api/open; Volcengine Doubao Seedream v.v. qua /api/multimodal; Midjourney qua /api/mj).

POSTVăn bản sang ảnh (OpenAI)

https://api.robovai.com/api/open/v1/images/generations

OpenAI gpt-image và các model tương tự. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/images/generations

POSTChỉnh sửa ảnh (OpenAI)

https://api.robovai.com/api/open/v1/images/edits

Chỉnh sửa ảnh từ ảnh tham chiếu. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/images/edits

POSTVăn bản sang ảnh (multimodal)

https://api.robovai.com/api/multimodal/v1/images/generations

Volcengine Doubao Seedream và các model multimodal tương tự. Đường dẫn đầy đủ: https://api.robovai.com/api/multimodal/v1/images/generations

Tạo video

Giao diện bất đồng bộ: gửi tác vụ để lấy task_id, rồi polling cho đến khi thành công và trả về result_url.

POSTGửi tác vụ tạo

https://api.robovai.com/api/multimodal/v1/videos/generations

Gửi tạo video, trả về task_id. Đường dẫn đầy đủ: https://api.robovai.com/api/multimodal/v1/videos/generations

GETPolling trạng thái tác vụ

https://api.robovai.com/api/multimodal/v1/videos/tasks/:task_id

Truy vấn trạng thái tác vụ; trả về result_url khi thành công. Đường dẫn đầy đủ: https://api.robovai.com/api/multimodal/v1/videos/tasks/:task_id

Trường	Kiểu	Bắt buộc	Mô tả
model	string	Có

Âm thanh

Endpoint âm thanh tương thích OpenAI: văn bản sang giọng nói, chuyển ngữ, dịch.

POSTVăn bản sang giọng nói

https://api.robovai.com/api/open/v1/audio/speech

TTS; nhận văn bản, trả về âm thanh. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/audio/speech

POSTChuyển ngữ

https://api.robovai.com/api/open/v1/audio/transcriptions

Âm thanh sang văn bản. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/audio/transcriptions

POSTDịch

https://api.robovai.com/api/open/v1/audio/translations

Dịch âm thanh sang văn bản ngôn ngữ đích. Đường dẫn đầy đủ: https://api.robovai.com/api/open/v1/audio/translations

Trường	Kiểu	Bắt buộc	Mô tả
model	string	Có	ID model (vd. gpt-image, dòng Seedream).
prompt	string	Có	Prompt mô tả ảnh.
n	integer	Không	Số ảnh, mặc định 1.
size	string	Không	Kích thước ảnh, vd. 1024x1024.
quality	string	Không	Chất lượng (OpenAI): standard/hd.
response_format

Ví dụ request

apiDocs.modalities.image.request

Ví dụ response

apiDocs.modalities.image.response

Ví dụ request

apiDocs.modalities.video.request

Ví dụ response

apiDocs.modalities.video.submitResponse

Ví dụ request

apiDocs.modalities.audio.request

Ví dụ response

(luồng âm thanh nhị phân, Content-Type: audio/mpeg)

model	string	Có	ID model (vd. tts-1).
input	string	Có	Văn bản cần tổng hợp.
voice	string	Có	Giọng đọc, vd. alloy, echo, nova.
response_format	string	Không	Định dạng âm thanh: mp3/opus/aac/flac, mặc định mp3.
speed	number	Không	Tốc độ, 0.25–4, mặc định 1.