Developers
Tài liệu các endpoint công khai của API. Trong Phase 1, API chạy sau SSH tunnel tại http://127.0.0.1:3001.
Xác thực
Gửi API key trong header Authorization: Bearer ck_…. Tạo key ở Dashboard. Khách dùng header X-Guest-Token và chỉ gọi được các model cho phép khách.
Endpoint
| Method | Đường dẫn | Mô tả |
|---|---|---|
| POST | /v1/chat/completions | Chat theo định dạng chat.completion. Nội dung nằm ở choices[0].message.content. |
| POST | /v1/images/generations | Tạo ảnh. Mỗi phần tử trong data có b64_json. |
| POST | /v1/videos/generations | Tạo job video. Trả về 202 với id và status "queued". |
| GET | /v1/jobs/{id} | Xem trạng thái job, output, lỗi và chi phí. |
| GET | /v1/files/{id} | Tải file do job tạo ra (video). |
| GET | /v1/models | Danh sách model đang bật, kèm chi phí credit. |
| GET | /v1/credits/balance | Số dư credit của tài khoản. |
| GET | /v1/usage | Tối đa 50 job gần nhất. |
Ví dụ với curl
curl http://127.0.0.1:3001/v1/chat/completions \
-H "Authorization: Bearer ck_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "MODEL_SLUG", "messages": [{"role": "user", "content": "Xin chào"}]}'Thay ck_YOUR_API_KEY bằng key của bạn và MODEL_SLUG bằng một slug trong bảng bên dưới.
Model
| Slug | Loại | Tier | Khách dùng được | Credit / lần |
|---|---|---|---|---|
| mock-text-1 | TEXT | FREE | Có | 10 |
| mock-image-1 | IMAGE | FREE | Có | 20 |
| mock-video-1 | VIDEO | FREE | Không | 5 |
Đặc tả OpenAPI
Danh sách dưới đây đọc từ docs/openapi.yaml. Tải file đặc tả đầy đủ tại openapi.yaml. Endpoint “Chưa hoàn thiện” chưa hoạt động đầy đủ trên gateway.
| Method | Đường dẫn | Tóm tắt | Truy cập | Trạng thái |
|---|---|---|---|---|
| GET | /healthz | Gateway liveness | public | Sẵn sàng |
| GET | /readyz | Gateway readiness | public | Sẵn sàng |
| POST | /v1/auth/register | Create an account | public | Sẵn sàng |
| POST | /v1/auth/login | Log in and get a session token | public | Sẵn sàng |
| POST | /v1/auth/logout | End the current session | principal | Sẵn sàng |
| GET | /v1/me | The signed-in user | principal | Sẵn sàng |
| POST | /v1/guest/sessions | Start a guest session | public | Sẵn sàng |
| GET | /v1/api-keys | List your API keys | user | Sẵn sàng |
| POST | /v1/api-keys | Create an API key | user | Sẵn sàng |
| DELETE | /v1/api-keys/{id} | Revoke an API key | user | Sẵn sàng |
| GET | /v1/models | List enabled models | public | Sẵn sàng |
| GET | /v1/capabilities | Models grouped by capability | public | Sẵn sàng |
| GET | /v1/credits/balance | Credit balance of the account | account | Sẵn sàng |
| GET | /v1/usage | Your last 50 jobs | principal | Sẵn sàng |
| POST | /v1/chat/completions | Chat completion (synchronous) | principal | Sẵn sàng |
| POST | /v1/images/generations | Image generation (synchronous) | principal | Sẵn sàng |
| POST | /v1/videos/generations | Video generation (asynchronous, text or image to video) | principal | Sẵn sàng |
| POST | /v1/stories/generations | Story generation (synchronous) | principal | Sẵn sàng |
| GET | /v1/jobs/{id} | Read one job | principal | Sẵn sàng |
| GET | /v1/files/{id} | Download the file of a completed video job | principal | Sẵn sàng |
| GET | /v1/admin/providers | List providers with their models | admin | Sẵn sàng |
| POST | /v1/admin/providers | Register a provider | admin | Sẵn sàng |
| PATCH | /v1/admin/models/{id} | Enable or disable a model, or change its credit cost | admin | Sẵn sàng |
| POST | /v1/admin/credits/grant | Grant credits to an account | admin | Sẵn sàng |
| GET | /v1/admin/jobs | List jobs across all owners | admin | Sẵn sàng |
| GET | /v1/payments/packages | Active credit packages | public | Sẵn sàng |
| POST | /v1/payments/orders | Create a credit order | user | Sẵn sàng |
| GET | /v1/payments/orders/{id} | Read one of your orders | user | Sẵn sàng |
| POST | /v1/payments/webhooks/sandbox | Sandbox payment provider webhook | public | Sẵn sàng |
| POST | /v1/admin/payments/orders/{id}/confirm | Confirm a bank-transfer order by hand (admin) | admin | Chưa hoàn thiện |
| POST | /v1/workflows | Create a workflow definition | user | Sẵn sàng |
| POST | /v1/workflows/templates/{name} | Create a workflow from a named template | user | Sẵn sàng |
| POST | /v1/workflows/{id}/runs | Start a run of a workflow | user | Sẵn sàng |
| GET | /v1/workflow-runs/{id} | Read a workflow run and its steps | user | Sẵn sàng |
| POST | /v1/workflow-runs/{id}/cancel | Cancel a run that has not finished | user | Sẵn sàng |
| POST | /v1/assets | Upload a file | account | Chưa hoàn thiện |
| GET | /v1/assets/{id} | Read asset metadata | account | Sẵn sàng |
| DELETE | /v1/assets/{id} | Delete an asset | account | Sẵn sàng |
| GET | /v1/assets/{id}/content | Download asset bytes | account | Sẵn sàng |
SDK
- JavaScript:
sdk/js - Python:
sdk/python
Thư mục SDK nằm trong kho mã của dự án. Quản trị viên có thể đặt biến môi trường SDK_REPO_URL để trang liên kết trực tiếp tới các thư mục này.