Friday API调用指南
Friday智能原创文章生成,为文案写作/SEO优化等应用场景提供批量生成的能力。现在支持中、英、法、西班牙语的全文生成以及英文的段落生成。
注:API仍处在beta测试中,请使用方注意接口使用的合规性,不得利用该接口从事不合规场景的应用;如有违规使用,一经发现,Friday团队有权立即停止提供服务。
目录
1. 内容生成接口
1.1 接口说明
使用Http请求调用Friday API
接口内容 | 说明 |
---|
传输方式 | Post |
请求地址 | openapi.heyfriday.cn/fridayapi |
qps | 5 |
1.2 Header 参数
参数名称 | 参数值 |
---|
Content-Type | application/json; charset=UTF-8 |
1.3 请求参数
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
abilityType | String | Y | N | 选择能力 (见能力列表) |
abilityInput | Map | Y | N | 能力所需参数(见能力列表) |
accessKeyId | String | Y | N | Friday公钥 |
accessKeySecret | String | Y | N | Friday私钥 |
1.4 能力列表
1.4.1 微信公众号全文生成
{
"abilityType":"wechat_artcle_gen_plus",
"abilityInput":{
"blogTitle":"人工智能在教育行业的应用",
"keywords":["智慧课堂","智慧教育"]
}
}
1
2
3
4
5
6
7
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
blogTitle | String | Y | N | 文章标题 |
keywords | List[String] | Y | N | 文章关键词 |
1.4.2 英文文章全文生成
{
"abilityType":"en_artcle_gen",
"abilityInput":{
"keywords":["amazon","seo"]
}
}
1
2
3
4
5
6
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
keywords | List[String] | Y | N | 文章关键词 |
1.4.3 法语文章全文生成
{
"abilityType":"french_artcle_gen",
"abilityInput":{
"keywords":["amazon","seo"]
}
}
1
2
3
4
5
6
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
keywords | List[String] | Y | N | 文章关键词 |
1.4.4 西班牙语文章全文生成
{
"abilityType":"spanish_artcle_gen",
"abilityInput":{
"keywords":["amazon","seo"]
}
}
1
2
3
4
5
6
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
keywords | List[String] | Y | N | 文章关键词 |
1.4.5 英语文章章节生成
{
"abilityType":"blog_section_gen",
"abilityInput":{
"blogTitle":"the development of AI",
"keywords":["machine learning","deep learning"]
}
}
1
2
3
4
5
6
7
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
blogTitle | String | Y | N | 章节标题 |
keywords | List[String] | Y | N | 章节关键词 |
1.5 返回内容
正常返回
{
"statusCode":0,
"result":"人工智能……解决方案。",
"requestId":"单次请求唯一标识,用于问题定位"
}
1
2
3
4
5
异常返回
{
"statusCode":10002,
"errorMsg":["run out of token"]
}
1
2
3
4
1.6 示例代码
python调用实例
import requests
postdata = {
"abilityType":"wechat_artcle_gen_plus",
"abilityInput":{
"blogTitle":"人工智能在教育行业的应用",
"keywords":["智慧课堂","智慧教育"]
},
"accessKeyId":"你的Friday公钥",
"accessKeySecret":"你的Friday私钥"
}
print(postdata)
r = requests.post('http://openapi.heyfriday.cn/fridayapi/',json=postdata)
print(r.json()["result"])
return r.json()["result"]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
java调用实例
Map<String, Object> postdata = new HashMap<>();
postdata.put("abilityType", "wechat_artcle_gen_plus");
Map<String, Object> input = new HashMap<>();
input.put("blogTitle", "人工只能在教育行业的应用");
List<String> keywords = new ArrayList<>();
keywords.add("智慧课堂");
keywords.add("智慧教育");
input.put("keywords", keywords);
postdata.put("abilityInput", input);
postdata.put("accessKeyId", "你的Friday公钥");
postdata.put("accessKeySecret", "你的Friday私钥");
String params = JSON.toJSONString(postdata);
URL url = new URL("http://openapi.heyfriday.cn/fridayapi");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Connection", "Keep-Alive");
connection.setUseCaches(false);
connection.setDoOutput(true);
connection.setDoInput(true);
DataOutputStream out = new DataOutputStream(connection.getOutputStream());
out.write(params.getBytes(StandardCharsets.UTF_8));
out.flush();
out.close();
connection.connect();
BufferedReader in = null;
in = new BufferedReader(
new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8));
StringBuilder result = new StringBuilder();
String getLine;
while ((getLine = in.readLine()) != null) {
result.append(getLine);
}
in.close();
JSONObject resultJson = JSON.parseObject(result.toString());
System.out.println(resultJson.getString("result"));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
2.余额查看接口
2.1接口说明
使用Http请求调用余额查看接口
接口内容 | 说明 |
---|
传输方式 | Post |
请求地址 | openapi.heyfriday.cn/account-view |
2.2 Header 参数
参数名称 | 参数值 |
---|
Content-Type | application/json; charset=UTF-8 |
2.3 请求参数
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 |
---|
accessKeyId | String | Y | N | Friday公钥 |
accessKeySecret | String | Y | N | Friday私钥 |
2.4 返回内容
正常返回
{
"statusCode":0,
"result":"billing type:article,billing balance:1249"
}
1
2
3
4
异常返回
{
"statusCode":10003,
"errorMsg":["wrong accessKeyId or accessKeySecret"]
}
1
2
3
4
2.5 示例代码
python调用实例
import requests
postdata = {
"accessKeyId":"你的Friday公钥",
"accessKeySecret":"你的Friday私钥"
}
print(postdata)
r = requests.post('http://openapi.heyfriday.cn/account-view/',json=postdata)
print(r.json()["result"])
return r.json()["result"]
1
2
3
4
5
6
7
8
9
10
java调用实例
Map<String, Object> postdata = new HashMap<>();
postdata.put("accessKeyId", "你的Friday公钥");
postdata.put("accessKeySecret", "你的Friday私钥");
String params = JSON.toJSONString(postdata);
URL url = new URL("http://openapi.heyfriday.cn/account-view");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Connection", "Keep-Alive");
connection.setUseCaches(false);
connection.setDoOutput(true);
connection.setDoInput(true);
DataOutputStream out = new DataOutputStream(connection.getOutputStream());
out.write(params.getBytes(StandardCharsets.UTF_8));
out.flush();
out.close();
connection.connect();
BufferedReader in = null;
in = new BufferedReader(
new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8));
StringBuilder result = new StringBuilder();
String getLine;
while ((getLine = in.readLine()) != null) {
result.append(getLine);
}
in.close();
JSONObject resultJson = JSON.parseObject(result.toString());
System.out.println(resultJson.getString("result"));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
3.账单查看接口
3.1接口说明
使用Http请求调用账单查看接口 可查询的最早日期为:2022-09-23
接口内容 | 说明 |
---|
传输方式 | Post |
请求地址 | openapi.heyfriday.cn/bill-view |
3.2 Header 参数
参数名称 | 参数值 |
---|
Content-Type | application/json; charset=UTF-8 |
3.3 请求参数
参数名称 | 数据类型 | 是否必填 | 是否可以为空 | 参数介绍 | 示例 |
---|
accessKeyId | String | Y | N | Friday公钥 | |
accessKeySecret | String | Y | N | Friday私钥 | |
startDate | String | Y | N | 开始日期 | 2022-10-10 |
endDate | String | Y | N | 结束日期 | 2022-10-31 |
参数说明: 日期的格式必须为"yyyy-mm-dd" eg:2022-10-31
账单结果包含:开始日期和结束日期当天的消费 3.4 返回内容
正常返回
{
"statusCode":0,
"result":"From 2022-10-10 to 2022-10-31, your consumption is:658"
}
1
2
3
4
异常返回
{
"statusCode":10003,
"errorMsg":["wrong accessKeyId or accessKeySecret"]
}
1
2
3
4
{
"statusCode": 10007,
"errorMsg": ["Incorrect date format"]
}
1
2
3
4
5
3.5 示例代码
python调用实例
import requests
postdata = {
"accessKeyId":"你的Friday公钥",
"accessKeySecret":"你的Friday私钥",
"startDate":"开始日期",
"endDate":"结束日期"
}
print(postdata)
r = requests.post('http://openapi.heyfriday.cn/bill-view/',json=postdata)
print(r.json()["result"])
return r.json()["result"]
1
2
3
4
5
6
7
8
9
10
11
12
java调用实例
Map<String, Object> postdata = new HashMap<>();
postdata.put("accessKeyId", "你的Friday公钥");
postdata.put("accessKeySecret", "你的Friday私钥");
postdata.put("startDate", "开始日期");
postdata.put("endDate", "结束日期");
String params = JSON.toJSONString(postdata);
URL url = new URL("http://openapi.heyfriday.cn/account-view");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Connection", "Keep-Alive");
connection.setUseCaches(false);
connection.setDoOutput(true);
connection.setDoInput(true);
DataOutputStream out = new DataOutputStream(connection.getOutputStream());
out.write(params.getBytes(StandardCharsets.UTF_8));
out.flush();
out.close();
connection.connect();
BufferedReader in = null;
in = new BufferedReader(
new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8));
StringBuilder result = new StringBuilder();
String getLine;
while ((getLine = in.readLine()) != null) {
result.append(getLine);
}
in.close();
JSONObject resultJson = JSON.parseObject(result.toString());
System.out.println(resultJson.getString("result"));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
4.错误码
错误码 | 含义 | 解决方案 |
---|
10001 | 预购字数用完 | 联系客服购买字数包 |
10002 | 请求超时 | 请重试 |
10003 | 鉴权未通过 | 检查accessKeyId与accessKeySecret |
10004 | 系统错误 | 请重试 |
10005 | abilityType有误 | 请检查abilityType参数或联系客服 |
10006 | 传入参数值为空 | 请按照能力列表中的要求传参 |
10007 | 日期格式有误 | 格式为YYYY-MM-DD |
10008 | QPS超过限制 | 请联系客服 |
10009 | abilityInput有误 | 请检查参数 |
10010 | 内容审核失败 | 请尝试其他输入 |
如何联系Friday并获得API使用权
联系邮箱📭:friday@heyfriday.ai