API 参考文档

强大的AI软件开发API,让您的应用更智能

快速开始

在几分钟内集成BistuAI API到您的应用中

🔑

获取API密钥

注册账户并获取您的API密钥

📚

查看文档

了解可用的API端点和参数

🚀

开始集成

使用SDK或直接调用API

身份验证

选择适合您需求的身份验证方式

API Key

使用API密钥进行身份验证

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

使用OAuth 2.0进行身份验证

Authorization: Bearer ACCESS_TOKEN

JWT Token

使用JWT令牌进行身份验证

Authorization: Bearer JWT_TOKEN

API 端点

完整的API端点列表和详细说明

POST /api/v1/ai/generate-code

AI代码生成

参数

prompt (string) 必需 - 代码生成提示
language (string) 必需 - 编程语言
framework (string) 可选 - 框架选择

响应

{
  "code": "string",
  "explanation": "string",
  "suggestions": "array"
}
POST /api/v1/ai/analyze-code

AI代码分析

参数

code (string) 必需 - 要分析的代码
analysis_type (string) 必需 - 分析类型:quality, security, performance

响应

{
  "score": "number",
  "issues": "array",
  "recommendations": "array"
}
GET /api/v1/projects

获取项目列表

参数

user_id (string) 必需 - 用户ID
status (string) 可选 - 项目状态过滤

响应

{
  "projects": "array",
  "total": "number",
  "page": "number"
}
POST /api/v1/projects

创建新项目

参数

name (string) 必需 - 项目名称
description (string) 可选 - 项目描述
template (string) 可选 - 项目模板

响应

{
  "project_id": "string",
  "name": "string",
  "created_at": "timestamp"
}
PUT /api/v1/projects/{id}

更新项目信息

参数

id (string) 必需 - 项目ID
name (string) 可选 - 新项目名称
description (string) 可选 - 新项目描述

响应

{
  "success": "boolean",
  "updated_at": "timestamp"
}
DELETE /api/v1/projects/{id}

删除项目

参数

id (string) 必需 - 项目ID

响应

{
  "success": "boolean",
  "deleted_at": "timestamp"
}

代码示例

多种编程语言的集成示例

AI代码生成示例

JavaScript
const response = await fetch('/api/v1/ai/generate-code', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: '创建一个用户登录表单',
    language: 'javascript',
    framework: 'react'
  })
});

const result = await response.json();
console.log(result.code);

项目创建示例

Python
import requests

response = requests.post(
    'https://api.syntro.com/api/v1/projects',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'name': '我的新项目',
        'description': '这是一个使用AI生成的Web应用'
    }
)

project = response.json()
print(f"项目ID: {project['project_id']}")

代码分析示例

cURL
curl -X POST https://api.syntro.com/api/v1/ai/analyze-code \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "function hello() { console.log('Hello World'); }",
    "analysis_type": "quality"
  }'

SDK 库

官方支持的编程语言SDK,简化API集成

JavaScript/Node.js

版本 v2.1.0
npm install @syntro/api
查看文档 →

Python

版本 v2.1.0
pip install syntro-api
查看文档 →

Go

版本 v2.1.0
go get github.com/syntro/syntro-go
查看文档 →

PHP

版本 v2.1.0
composer require syntro/api
查看文档 →

速率限制

根据您的订阅计划了解API调用限制

免费版

1,000/天
每日请求
100/分钟
突发请求

专业版

100,000/天
每日请求
1,000/分钟
突发请求

企业版

无限制
每日请求
无限制
突发请求

准备开始了吗?

立即注册获取API密钥,开始构建智能应用