Lindorm AI引擎提供了一系列RESTful風格的API，您可以調用這些API進行模型管理、模型推理和參數調整。本文介紹使用Lindorm AI RESTful API進行應用開發的串連地址、認證機制、應答格式和支援的API操作類型。
前提條件
已開通AI引擎。如何開通，請參見開通指南。
認證機制
您需要在發送HTTP請求時，在要求標頭（header）中添加以下Key：
x-ld-ak：訪問AI引擎的使用者名稱。
x-ld-sk：訪問AI引擎的密碼。
如何擷取，請參見擷取串連資訊。
公用請求URL參數
REST API支援的URL參數如下：
參數名 | 類型 | 說明 |
pretty | BOOLEAN | 指定應答JSON是否以pretty方式顯示，提升可讀性。 |
應答格式
REST API使用標準的HTTP狀態代碼，並在HTTP Body中使用JSON格式的內容描述請求執行的詳細情況。
狀態代碼列表
HttpStatusCode | 說明 |
200 OK | 請求執行成功。 |
400 Bad Request | 錯誤的請求，訪問的URI格式或輸入參數不合法。 |
401 Unauthorized Request | 請求認證失敗。 |
404 Not Found | 訪問的URI不存在 |
405 Method Not Allowed | HTTP要求方法錯誤。 |
413 Request Entity Too Large | 請求實體過大。 |
500 Internal Server Error | 內部錯誤，服務端異常。 |
應答內容格式
{
"code": 0,
"msg": "",
"data": "",
"success": true
}應答內容欄位 | 說明 |
code | 狀態代碼，取值如下：
|
msg |
|
data | 請求執行結果，不同請求有不同的格式，詳見各API定義。 |
success | 是否執行成功。取值如下：
|
API操作流程
類型 | 說明 | 參考文檔 |
模型管理（模型部署、查看模型資訊等） | 使用模型管理RESTful API介面部署模型、查看模型列表、查看模型詳細資料、刪除指定模型、模型檔案上傳等。 | |
模型推理 | 使用模型推理RESTful API介面進行推理來實現多種功能，如特徵抽取、QA問答、語義相似性等。 | |
參數調整 | 使用參數調整RESTful API介面調整已部署模型的參數配置。 |