关键是要让调用方首次阅读提示词文档即可准确发起api请求并获得预期响应,需严格对齐“用户操作”与“系统识别”,从鉴权、参数、响应到示例全部按真实调用链展开。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

要让调用方第一次看提示词文档就能准确发起API请求、拿到预期响应,关键不是堆砌术语,而是把“他们要做什么”和“系统认什么”严丝合缝地对齐——从鉴权方式到参数命名,从必填字段到错误码含义,全部按真实调用链条展开。
明确标注身份验证方式
第一步,在文档开头用单独段落写清鉴权类型:如果是Bearer Token,直接写【必须在Header中携带Authorization: Bearer {your_token}】;如果是API Key,则写明字段名(如X-API-Key)和位置(Header还是Query)。不写“支持多种鉴权”,只写本次接口实际要求的那一种。
这一步漏掉或模糊,调用方连401都收不到——请求根本发不出去。
参数表按请求路径分层呈现
方法一:路径参数(Path Parameter)
例如 /v1/chat/{model_id},表格第一行列出model_id,注明“必填”“字符串”“取值范围:qwen-max、qwen-plus”,并在下方加一句提示:模型ID区分大小写,qwen-MAX会返回404。
方法二:查询参数(Query Parameter)
如temperature、top_p,统一放在第二张表。每个参数单列一行,类型写具体(不是“数值”,而是“浮点数,范围0.1–2.0”),默认值写明(如“默认1.0”),并标注是否参与签名计算——【若参与签名,修改后需重新生成Signature】。
方法三:请求体(Request Body)
用JSON结构树形式展示,嵌套层级清晰。messages字段下每一项必须标明role(system/user/assistant)和content(字符串,最大长度4096字符),role值写死,不接受role: "user"以外的变体写法。
响应示例必须带真实字段与典型错误
第一步:给出一个完整、可复制粘贴的成功响应JSON,字段值用真实业务数据(如id: "chat_abc123",不是"id": "string")。
第二步:紧接其后列两个高频失败响应:
① 400 Bad Request时返回{"code":"INVALID_PARAMETER","message":"messages[0].role must be 'system', 'user' or 'assistant'"}——这个message字段内容要和实际返回完全一致;
② 429 Too Many Requests时返回{"code":"RATE_LIMIT_EXCEEDED","message":"You have exceeded your current quota."},并补充说明:配额重置时间为UTC每日0点,非北京时间。
不放“常见错误码汇总表”,只放调用方此刻最可能撞上的那两个。
curl示例必须能一键执行
提供一条完整curl命令,包含所有必要参数和转义处理。例如:
curl -X POST https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation \
-H "Authorization: Bearer sk-xxx" \
-H "Content-Type: application/json" \
-d '{"model":"qwen-plus","input":{"messages":[{"role":"user","content":"你好"}]},"parameters":{"temperature":0.85}}'
注意:token值用sk-xxx占位,但明确标注【请替换为你的实际DashScope API Key】;JSON内中文不URL编码,curl命令末尾不加换行符,否则Linux下执行会报错。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











