Friday API调用指南

Friday智能原创文章生成,为文案写作/SEO优化等应用场景提供批量生成的能力。现在支持中、英、法、西班牙语的全文生成以及英文的段落生成。

注:API仍处在beta测试中,请使用方注意接口使用的合规性,不得利用该接口从事不合规场景的应用;如有违规使用,一经发现,Friday团队有权立即停止提供服务。

目录

1. 内容生成接口

1.1 接口说明

使用Http请求调用Friday API

接口内容说明
传输方式Post
请求地址openapi.heyfriday.cn/fridayapi
qps5

1.2 Header 参数

参数名称参数值
Content-Typeapplication/json; charset=UTF-8

1.3 请求参数

参数名称数据类型是否必填是否可以为空参数介绍
abilityTypeStringYN选择能力 (见能力列表)
abilityInputMapYN能力所需参数(见能力列表)
accessKeyIdStringYNFriday公钥
accessKeySecretStringYNFriday私钥

1.4 能力列表

1.4.1 微信公众号全文生成

{
    "abilityType":"wechat_artcle_gen_plus",
    "abilityInput":{
        "blogTitle":"人工智能在教育行业的应用",
        "keywords":["智慧课堂","智慧教育"]
        }
}
abilityInput
参数名称数据类型是否必填是否可以为空参数介绍
blogTitleStringYN文章标题
keywordsList[String]YN文章关键词

1.4.2 英文文章全文生成

{
    "abilityType":"en_artcle_gen",
    "abilityInput":{
        "keywords":["amazon","seo"]
        }
}
abilityInput
参数名称数据类型是否必填是否可以为空参数介绍
keywordsList[String]YN文章关键词

1.4.3 法语文章全文生成

{
    "abilityType":"french_artcle_gen",
    "abilityInput":{
        "keywords":["amazon","seo"]
        }
}
abilityInput
参数名称数据类型是否必填是否可以为空参数介绍
keywordsList[String]YN文章关键词

1.4.4 西班牙语文章全文生成

{
    "abilityType":"spanish_artcle_gen",
    "abilityInput":{
        "keywords":["amazon","seo"]
        }
}
abilityInput
参数名称数据类型是否必填是否可以为空参数介绍
keywordsList[String]YN文章关键词

1.4.5 英语文章章节生成

{
    "abilityType":"blog_section_gen",
    "abilityInput":{
        "blogTitle":"the development of AI",
        "keywords":["machine learning","deep learning"]
        }
}
abilityInput
参数名称数据类型是否必填是否可以为空参数介绍
blogTitleStringYN章节标题
keywordsList[String]YN章节关键词

1.5 返回内容

正常返回

{
    "statusCode":0,
    "result":"人工智能……解决方案。",
    "requestId":"单次请求唯一标识,用于问题定位"
}

异常返回

{
    "statusCode":10002,
    "errorMsg":["run out of token"]
}

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"]

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");
// 打开和URL之间的连接
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输入流来读取URL的响应
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"));

2.余额查看接口

2.1接口说明

使用Http请求调用余额查看接口

接口内容说明
传输方式Post
请求地址openapi.heyfriday.cn/account-view

2.2 Header 参数

参数名称参数值
Content-Typeapplication/json; charset=UTF-8

2.3 请求参数

参数名称数据类型是否必填是否可以为空参数介绍
accessKeyIdStringYNFriday公钥
accessKeySecretStringYNFriday私钥

2.4 返回内容

正常返回

{
    "statusCode":0,
    "result":"billing type:article,billing balance:1249"
}

异常返回

{
    "statusCode":10003,
    "errorMsg":["wrong accessKeyId or accessKeySecret"]
}

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"]

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");
// 打开和URL之间的连接
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输入流来读取URL的响应
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"));

3.账单查看接口

3.1接口说明

使用Http请求调用账单查看接口 可查询的最早日期为:2022-09-23

接口内容说明
传输方式Post
请求地址openapi.heyfriday.cn/bill-view

3.2 Header 参数

参数名称参数值
Content-Typeapplication/json; charset=UTF-8

3.3 请求参数

参数名称数据类型是否必填是否可以为空参数介绍示例
accessKeyIdStringYNFriday公钥
accessKeySecretStringYNFriday私钥
startDateStringYN开始日期2022-10-10
endDateStringYN结束日期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"
}

异常返回

{
    "statusCode":10003,
    "errorMsg":["wrong accessKeyId or accessKeySecret"]
}

{
    "statusCode": 10007,
    "errorMsg": ["Incorrect date format"]
}

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"]

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");
// 打开和URL之间的连接
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输入流来读取URL的响应
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"));

4.错误码

错误码含义解决方案
10001预购字数用完联系客服购买字数包
10002请求超时请重试
10003鉴权未通过检查accessKeyId与accessKeySecret
10004系统错误请重试
10005abilityType有误请检查abilityType参数或联系客服
10006传入参数值为空请按照能力列表中的要求传参
10007日期格式有误格式为YYYY-MM-DD
10008QPS超过限制请联系客服
10009abilityInput有误请检查参数
10010内容审核失败请尝试其他输入

如何联系Friday并获得API使用权

联系邮箱📭:friday@heyfriday.ai