~/docs/getting-started/overview/

概述

蜀农 API 为应用提供稳定的模型推理接口，兼容 OpenAI Chat Completions API。你可以使用标准 HTTP 请求或现有 SDK，将文本对话、图片理解、流式输出和工具调用接入自己的应用。

核心能力

  • 文本对话：通过消息列表完成单轮或多轮对话。
  • 多模态理解：向支持视觉的模型发送图片 URL 或 Base64 图片。
  • 流式输出：以 Server-Sent Events 逐步接收模型生成内容。
  • 工具调用：让模型根据上下文选择并调用业务函数。
  • 深度思考：开启后模型先输出思考过程，再给出最终回答。
  • OpenAI 兼容：复用已有的 SDK、请求结构和工程经验。

接入流程

  1. 创建蜀农 API 账号并获取 API Key。
  2. 将 API Key 配置到服务端环境变量。
  3. 选择可用模型并确认接口地址。
  4. 发起一次 Chat Completions 请求。
  5. 根据业务需要启用流式响应、图片输入或工具调用。

基础配置

Base URL: https://ai.agriwis.com/api/v1
Endpoint: POST /chat/completions
认证方式: Authorization: Bearer <API_KEY>

MCP 接入

除 REST 接口外，蜀农 API 还提供 MCP（Model Context Protocol）端点。把端点地址和 API Key 配置到支持 MCP 的客户端（Claude Code、Claude Desktop、Cursor、Cline 等）后，客户端即可直接调用天气搜索、知识库检索、生长周期识别与当前时间工具，无需编写适配代码。

Endpoint: https://ai.agriwis.com/mcp
传输方式: Streamable HTTP
认证方式: Authorization: Bearer <API_KEY>

详见 MCP 概述、MCP 工具参考与 客户端接入。

API Key 只应在服务端使用。不要把密钥写入前端代码、移动端包或公开仓库。