Hướng dẫn
Tổng quan API
Toàn bộ API công khai, phương thức xác thực và tài liệu chi tiết tương ứng
Tổng quan API
Địa chỉ cơ sở thống nhất là https://locopalai.com, tất cả API đều dùng cùng một khóa API nền tảng. Quy ước chung (xác thực, cấu trúc phản hồi, phân trang, giới hạn tần suất, tính idempotent) xem Xác thực và quy chuẩn cơ bản.
API mô hình và tạo sinh
| Mục đích | Phương thức | Đường dẫn | Tài liệu chi tiết |
|---|---|---|---|
| Truy vấn mô hình khả dụng | GET | /v1/models | API mô hình và văn bản |
| Hội thoại văn bản (bao gồm dạng luồng) | POST | /v1/chat/completions | API mô hình và văn bản |
| Tạo hình ảnh | POST | /v1/images/generations | API tạo hình ảnh |
| Chuyển văn bản thành giọng nói | POST | /v1/audio/speech | API chuyển văn bản thành giọng nói |
| Tạo tác vụ video | POST | /v1/video/generations | API tạo video |
| Truy vấn tác vụ video | GET | /v1/video/generations/{task_id} | API tạo video |
| Tạo tác vụ video (cách viết tương thích OpenAI) | POST | /v1/videos | API tạo video |
| Truy vấn tác vụ video (cách viết tương thích OpenAI) | GET | /v1/videos/{task_id} | API tạo video |
API thư viện tư liệu
Tất cả API thư viện tư liệu đều dùng khóa API, khi thành công trả về thống nhất { "code": 0, "data": ..., "msg": "..." }.
| Mục đích | Phương thức | Đường dẫn | Tài liệu chi tiết |
|---|---|---|---|
| Truy vấn nhóm tư liệu | GET | /api/v1/materials/groups | Nhóm tư liệu |
Tạo nhóm tư liệu (virtual / real) | POST | /api/v1/materials/groups | Nhóm tư liệu |
Truy vấn danh sách tư liệu (hỗ trợ group_id, phân trang) | GET | /api/v1/materials/assets | Tư liệu |
Gửi tư liệu hình ảnh (image_url hoặc data_url) | POST | /api/v1/materials/assets | Tư liệu |
| Truy vấn trạng thái một tư liệu | GET | /api/v1/materials/assets/{asset_id} | Tư liệu |
| Đồng bộ trạng thái tư liệu | POST | /api/v1/materials/sync | Đồng bộ trạng thái tư liệu |
| Tạo phiên ủy quyền quét mã cho người thật | POST | /api/v1/materials/portrait/sessions | Ủy quyền tư liệu người thật |
| Xác nhận hoàn tất quét mã người thật | POST | /api/v1/materials/portrait/resolve | Ủy quyền tư liệu người thật |
Tham số chi tiết, ví dụ và giải thích lỗi xem Tổng quan API thư viện tư liệu.
Chuỗi gọi điển hình
Mô hình và video
GET /v1/models
→ POST /v1/video/generations
→ GET /v1/video/generations/{task_id}Sau khi tạo tác vụ phải lưu ID tác vụ; khi mạng gián đoạn hãy tiếp tục truy vấn tác vụ gốc, không tạo lại.
Chuyển văn bản thành giọng nói
GET /v1/models
→ POST /v1/audio/speech
→ 保存二进制音频响应API âm thanh có khả dụng hay không, hỗ trợ những voice và response_format nào, căn cứ vào danh mục mô hình của Key hiện tại và năng lực thực tế của mô hình.
Tư liệu ảo
POST /api/v1/materials/groups
→ POST /api/v1/materials/assets
→ GET /api/v1/materials/assets/{asset_id} (轮询到 status 为 Active)
→ 在视频 content 中使用 asset://<asset_id>Tư liệu người thật
POST /api/v1/materials/groups {"type":"real"}
→ POST /api/v1/materials/portrait/sessions (拿到二维码链接)
→ 由真人本人扫码完成采集
→ POST /api/v1/materials/portrait/resolve
→ POST /api/v1/materials/sync
→ 查询素材状态后用于支持真人素材库的模型Ví dụ end-to-end xem Quy trình tích hợp tư liệu chân dung và video tham chiếu; ranh giới năng lực của nhiều ảnh và video tham chiếu xem Hướng dẫn nhiều ảnh và video tham chiếu.
Phản hồi và lỗi
| Loại API | Thành công | Thất bại |
|---|---|---|
| Mô hình / Hình ảnh / Video | Trả về trực tiếp đối tượng kết quả | HTTP không phải 2xx, đọc error.message |
| Thư viện tư liệu | { "code": 0, "data": ..., "msg": "OK" } | Mã trạng thái HTTP trùng với code |
Client phải kiểm tra đồng thời trạng thái HTTP và phần thân phản hồi. Mã lỗi đầy đủ và cách khắc phục xem Mã lỗi và khắc phục.
