一言开发文档

全面了解一言API的使用方法和开发指南

简介

一言API提供了简单易用的HTTP接口,支持多种返回格式和丰富的参数配置。通过调用API,您可以轻松获取随机的一句话,包括动漫台词、古诗词、网易云热评等多种类型。

接口说明

一言API采用RESTful设计,支持HTTPS协议,所有接口均采用GET方法请求。为了保证服务质量,接口设有请求频率限制。

时间规划

2020年

初版接口发布,实验性提供服务

2021年

cn接口发布,开始稳定提供服务

2022年

cn接口新增多类型,开始测试内测提供服务

2022年

cn接口新增多类型,开始稳定提供服务

2024年

com\cc接口新增20+类型,开始测试内测提供服务

版本规划

当前阶段

V1 版本迭代

  • ✓ 支持多种一言类型
  • ✓ 提供多种返回格式
  • ✓ 优化接口性能
  • · 计划支持更多语言类型
  • · 计划增加自定义接口
规划中

V2 版本规划

  • · 支持 WebSocket 连接
  • · 提供开发者平台
  • · 支持自定义语句库
  • · 提供完整的统计分析

请求地址

GET https://v1.xqapi.com/v1.php

基础接口地址,支持所有一言类型的获取。

平均响应:50ms QPS限制:2/s

请求参数

参数 类型 说明
y string 指定一言类型,可选值包括:
  • 段子
  • emo
  • QQ签名
  • 趣味笑话
  • 随机一言
  • 英汉语录
  • 爱情语录
  • 舔狗修养
  • 伤感语录
  • 舔狗日记
  • 社会语录
  • 诗词
  • 网易云
  • 经典语录
  • 默认
  • 人生话语
  • 网易语录
  • 诗句名言
  • 我在人间凑数的日子
type string 指定返回格式,可选值:
  • text - 纯文本格式(默认)
  • json - JSON格式

返回信息

JSON 格式

{
    "code": 200,
    "text": "一言内容",
    "type": "emo",
    "from": "来源信息"
}

纯文本格式

一言内容
字段 类型 说明
code integer 状态码,200 表示成功
text string 一言正文内容
type string 一言类型
from string 来源信息

使用示例

curl "https://v1.xqapi.com/v1.php?y=emo&type=json"
fetch('https://v1.xqapi.com/v1.php?y=emo&type=json')
    .then(response => response.json())
    .then(data => console.log(data));
$response = file_get_contents('https://v1.xqapi.com/v1.php?y=emo&type=json');
$data = json_decode($response, true);
echo $data['text'];
import requests

response = requests.get('https://v1.xqapi.com/v1.php?y=emo&type=json')
data = response.json()
print(data['text'])

错误代码

状态码 说明 解决方案
400 请求参数错误 检查参数格式是否正确
404 请求的资源不存在 检查请求的一言类型是否存在
429 请求过于频繁 降低请求频率,遵守 QPS 限制
500 服务器内部错误 请稍后重试或联系管理员