技术文档中心

全面的开发指南、API文档与最佳实践,助您轻松集成川意科技的产品和服务

API参考文档

本文档提供了川意科技API的详细参考信息,包括所有可用的端点、参数、响应格式和错误处理指南。使用这些API,您可以集成我们的人工智能、数据分析和云服务能力。

基本信息

基础URL

所有API请求都应使用以下基础URL:

https://api.chuanyi-tech.com/v2/

身份验证

所有API请求都需要在HTTP头中包含您的API密钥进行身份验证:

Authorization: Bearer YOUR_API_KEY

API端点概览

我们的API按功能模块组织,每个模块提供不同的服务能力:

分析API

提供文本、图像和数据分析能力

POST /analysis/text
POST /analysis/image
POST /analysis/data

生成API

提供文本、图像和代码生成能力

POST /generation/text
POST /generation/image
POST /generation/code

数据处理API

提供数据转换、清洗和导出能力

POST /data/transform
POST /data/clean
POST /data/export

存储API

提供文件和对象存储能力

POST /storage/upload
GET /storage/download
DELETE /storage/delete

详细API参考

分析API

文本、图像和数据分析

文本分析

对文本内容进行分析,包括情感分析、实体识别、关键词提取等功能。

POST/analysis/text

请求参数

{ "text": "需要分析的文本内容", "type": "sentiment", // 分析类型:sentiment (情感), entity (实体), keyword (关键词) "language": "zh", // 语言:zh (中文), en (英文) "options": { "detailed": true // 是否返回详细分析结果 } }

响应示例

{ "status": "success", "data": { "type": "sentiment", "result": { "sentiment": "positive", // positive, negative, neutral "score": 0.85, // 分数 (0-1) "details": { // 仅当options.detailed=true时返回 "positiveAspects": ["服务态度好", "价格合理"], "negativeAspects": [], "summary": "整体评价积极" } } } }

图像分析

对图像内容进行分析,包括对象识别、场景分类、内容审核等功能。

POST/analysis/image

请参考图像分析详细文档获取完整信息。

生成API

文本、图像和代码生成

文本生成

基于提示生成文本内容,可用于文案创作、对话生成、内容扩展等场景。

POST/generation/text

请参考文本生成详细文档获取完整信息。

图像生成

基于文本描述生成图像,支持多种风格和尺寸。

POST/generation/image

请参考图像生成详细文档获取完整信息。

数据处理API

数据转换、清洗和导出

关于数据处理API的详细文档正在编写中,敬请期待!

存储API

文件和对象存储

关于存储API的详细文档正在编写中,敬请期待!

错误处理

API使用标准HTTP状态码表示请求状态。具体错误信息会在响应体中提供。

状态码含义说明
200成功请求成功处理
400无效请求请求参数错误或缺失
401未授权API密钥无效或缺失
403禁止访问无权访问请求的资源
404资源不存在请求的资源不存在
429请求过多超出API调用限制
500服务器错误服务器内部错误

错误响应示例

{ "status": "error", "code": "invalid_parameter", "message": "缺少必要参数 'text'", "request_id": "req_2389ufhj23" }

速率限制

我们对API请求实施速率限制以确保服务质量。限制基于您的订阅计划,在响应头中可以查看当前限制信息:

X-RateLimit-Limit: 1000  # 每小时请求上限 X-RateLimit-Remaining: 950  # 当前周期内剩余请求数 X-RateLimit-Reset: 1627834520  # 下次重置时间的Unix时间戳

如果超出限制,将返回429 Too Many Requests状态码。您可以通过升级订阅计划来提高限制。

需要帮助?

如果您在使用API过程中遇到任何问题,或者需要更多帮助,可以通过以下方式获取支持: