add api language version
This commit is contained in:
parent
9a473a19bd
commit
74da86f7bf
38
wwwroot/public/api/api_en.md
Executable file
38
wwwroot/public/api/api_en.md
Executable file
@ -0,0 +1,38 @@
|
||||
# Yuanjing Platform API Specification
|
||||
|
||||
The Yuanjing Platform provides APIs compatible with the OpenAI protocol for downstream systems. To access the API, please complete the following steps:
|
||||
* Register an account
|
||||
* Log in
|
||||
* Apply for an APIKEY
|
||||
* Top up (Recharge)
|
||||
|
||||
Once completed, you can implement inference services for Text-to-Text, Text-to-Video (T2V), Image-to-Video (I2V), and Reference-to-Video (R2V). For supported models, please refer to the Model Hub.
|
||||
|
||||
## 1. Apply for APIKEY
|
||||
Users must log in via mobile at the Yuanjing Platform (https://ai.opencomputing.cn) and select "Create APIKEY". After submitting the required information, copy the generated APIKEY from the popup window.
|
||||
|
||||
## 2. Recharge
|
||||
Users can recharge their accounts on the platform. Currently, Alipay is supported.
|
||||
|
||||
## 3. Check Balance
|
||||
* Log in to the platform.
|
||||
* Call up the user menu.
|
||||
* Click on "Finance".
|
||||
|
||||
## 4. API Configuration
|
||||
* **Base URL:** https://opencomputing.ai
|
||||
|
||||
### OpenAI Compatible Chat Interface
|
||||
* Path: /llmage/v1/chat/completions
|
||||
* Method: POST
|
||||
* Headers:
|
||||
{
|
||||
"Content-Type": "application/json",
|
||||
"Authorization": "Bearer <your-apikey>"
|
||||
}
|
||||
|
||||
## 5. Task Status Query
|
||||
* Path: /llmage/tasks
|
||||
* Method: GET
|
||||
* Params: taskid
|
||||
* Statuses: SUCCEEDED, FAILED, CREATED, PENDING, RUNNING.
|
||||
30
wwwroot/public/api/api_ja.md
Executable file
30
wwwroot/public/api/api_ja.md
Executable file
@ -0,0 +1,30 @@
|
||||
# 元境プラットフォーム API 仕様書
|
||||
|
||||
元境プラットフォームは、OpenAI プロトコルと互換性のある API を提供します。下流システムで API を利用するには、以下の手順が必要です。
|
||||
* アカウント登録
|
||||
* ログイン
|
||||
* APIKEY の申請
|
||||
* チャージ
|
||||
|
||||
## 1. APIKEY の申請
|
||||
元境プラットフォーム (https://ai.opencomputing.cn) に携帯番号でログインし、「APIKEY 作成」を選択します。
|
||||
|
||||
## 2. チャージ
|
||||
プラットフォーム上でチャージが可能です。現在、Alipay(支付宝)をサポートしています。
|
||||
|
||||
## 3. API 接続情報
|
||||
* **ベース URL:** https://opencomputing.ai
|
||||
|
||||
### OpenAI 互換インターフェース
|
||||
* パス: /llmage/v1/chat/completions
|
||||
* メソッド: POST
|
||||
* ヘッダー:
|
||||
{
|
||||
"Content-Type": "application/json",
|
||||
"Authorization": "Bearer <your-apikey>"
|
||||
}
|
||||
|
||||
## 4. タスク状態の照会
|
||||
* パス: /llmage/tasks
|
||||
* メソッド: GET
|
||||
* ステータス: SUCCEEDED (成功), FAILED (失敗), CREATED, PENDING, RUNNING。
|
||||
30
wwwroot/public/api/api_ko.md
Executable file
30
wwwroot/public/api/api_ko.md
Executable file
@ -0,0 +1,30 @@
|
||||
# 원경(Yuanjing) 플랫폼 API 규격서
|
||||
|
||||
원경 플랫폼은 하위 시스템을 위해 OpenAI 인터페이스 프로토콜과 호환되는 API를 제공합니다.
|
||||
* 계정 등록
|
||||
* 로그인
|
||||
* APIKEY 신청
|
||||
* 충전
|
||||
|
||||
## 1. APIKEY 신청
|
||||
사용자는 원경 플랫폼(https://ai.opencomputing.cn)에서 휴대폰으로 로그인한 후 "APIKEY 생성"을 클릭합니다.
|
||||
|
||||
## 2. 충전
|
||||
사용자는 플랫폼에서 충전할 수 있으며, 현재 Alipay(알리페이)를 지원합니다.
|
||||
|
||||
## 3. API 연동 정보
|
||||
* **Base URL:** https://opencomputing.ai
|
||||
|
||||
### OpenAI 호환 인터페이스
|
||||
* 경로(Path): /llmage/v1/chat/completions
|
||||
* 메서드(Method): POST
|
||||
* 헤더(Headers):
|
||||
{
|
||||
"Content-Type": "application/json",
|
||||
"Authorization": "Bearer <your-apikey>"
|
||||
}
|
||||
|
||||
## 4. 작업 상태 조회
|
||||
* 경로: /llmage/tasks
|
||||
* 메서드: GET
|
||||
* 상태 값: SUCCEEDED(성공), FAILED(실패), CREATED, PENDING, RUNNING.
|
||||
Loading…
x
Reference in New Issue
Block a user