快速开始

PICPIK API采用指令式风格。每个API请求包含一个指令（Action）、指令参数和认证信息（PublicKey、Signature）。所有接口默认采用POST方法，application/json请求内容格式。

API计费方式详见：产品定价。

💰

我们为每个用户提供了300点免费额度用于测试。

公共参数

公共参数是在操作所有API的时候，都必需给出的参数，通常会展示在API文档所有参数的最上方。

参数名	类型	描述信息	必填
Action	`String`	对应的 API 指令名称	✓
PublicKey	`String`	用户公钥，可从 PICPIK用户中心 (opens in a new tab) 获取	✓
Signature	`String`	根据公钥及 API 指令生成的用户签名，参见签名算法	✓
request_uuid	`String`	请求uuid，采用uuid生成方式随机生成，可用于管理您业务和客户的请求

公共响应

公共响应是所有API都统一返回的字段信息，通常会展示在API文档所有响应字段的最上方。

字段名	类型	描述信息	必填
RetCode	`Int`	返回状态码，为 0 则为成功返回，非 0 为失败	✓
Action	`String`	操作指令名称	✓
Message	`String`	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息
request_uuid	`String`	返回请求时填写的uuid

快速开始

1. 获取密钥

从 PICPIK用户中心 (opens in a new tab) 获取API秘钥，包括PublicKey和PrivateKey

2. 准备请求数据

本例中假设：

PublicKey  = "abcdefg"
PrivateKey = "123456"

假设用户请求参数如下：

{
    "Action":    "ListModels",
    "PublicKey":    "abcdefg"
}

3. 计算签名

参考签名算法文档，计算出的签名(Signature)为：

4a20bc1141494035f6aaaad13224c94c5a8bc3a5

4. 选择请求地址

中国站和国际站的接口请求地址不同，本文档示例中均采用国际版PICPIK作为请求示例：

站点	请求地址
国际站	`https://api.picpik.ai`
中国站	`https://api.picpikai.com`

5. 构造请求

构造出的请求最终为：

curl -X POST \
  https://api.picpik.ai \
  -H 'Content-Type: application/json' \
  -d '{
      "Action"     :  "ListModels",
      "PublicKey"  :  "abcdefg",
      "Signature"  :  "4a20bc1141494035f6aaaad13224c94c5a8bc3a5"
  }'

签名算法