API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (PAILangStudio/2024-07-10) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Runtime
|
API |
Title |
Description |
| CreateRuntime | CreateRuntime | Creates a runtime. |
| UpdateRuntime | UpdateRuntime | Updates a runtime. |
| GetRuntime | GetRuntime | Get runtime details. |
| ListRuntimes | Retrieve Runtime List | Retrieve the runtime list. |
| DeleteRuntime | DeleteRuntime | Delete a runtime. |
Deployment tasks
|
API |
Title |
Description |
| UpdateDeployment | Update Deployment Job | Update a deployment job. |
| DeleteDeployment | Delete Deployment Job | Delete a deployment job. |
Snapshot management
|
API |
Title |
Description |
| GetSnapshot | Get Snapshot Details | Retrieves the details of a snapshot. |
| UpdateSnapshot | Update Snapshot | Update a snapshot. |
| ListSnapshots | Retrieve Snapshot List | Lists snapshots. |
Knowledge base
|
API |
Title |
Description |
| RetrieveKnowledgeBase | RetrieveKnowledgeBase | Retrieve the knowledge base. |
| CreateKnowledgeBaseJob | CreateKnowledgeBaseJob | Create a Knowledge Base Task. |
| GetKnowledgeBaseJob | Retrieve Knowledge Base Job | Retrieve a knowledge base job. |
| UpdateKnowledgeBaseJob | UpdateKnowledgeBaseJob | Update Knowledge Base Task. |
| DeleteKnowledgeBaseJob | DeleteKnowledgeBaseJob | Delete Knowledge Base Task. |
| ListKnowledgeBaseJobs | ListKnowledgeBaseJobs | Get the Knowledge Base task list. |
| UpdateKnowledgeBaseChunk | Update Knowledge Base Chunk | Update Knowledge Base Chunk |
| ListKnowledgeBaseChunks | ListKnowledgeBaseChunks | Retrieve the knowledge base segment list. |
Others
|
API |
Title |
Description |
| CreateDeployment | Create Deployment Job | Create a deployment job. |
| CreateKnowledgeBase | CreateKnowledgeBase | Create a knowledge base. |
| CreateSnapshot | Create Snapshot | Create a snapshot. |
| DeleteKnowledgeBase | DeleteKnowledgeBase | Delete knowledge base. |
| DeleteSnapshot | Delete Snapshot | Delete a snapshot. |
| GetDeployment | Get Deployment Task Details | Retrieve the details of a deployment job. |
| GetKnowledgeBase | GetKnowledgeBase | Get knowledge base. |
| ListDeployments | Retrieve a List of Deployment Jobs | Retrieve a list of deployment jobs. |
| ListKnowledgeBases | ListKnowledgeBases | Queries a list of knowledge bases. |
| UpdateKnowledgeBase | UpdateKnowledgeBase | Update Knowledge Base. |