RESTful API使用文档
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接口调整已部署模型的参数配置。 |