sage/wwwroot/public/api/api_en.md

39 lines
1.2 KiB
Markdown
Executable File

# 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.