创建文本响应
使用 ShareAI 响应 API 进行无状态文本生成、显式对话历史记录和响应流事件。
本页面内容
https://api.shareai.now/api/v1/responses从提示或对话生成文本响应。
- 基础 URL
https://api.shareai.now- 身份验证
- Bearer API 密钥或已批准的 OAuth 访问令牌
当您的应用程序使用响应文本消息格式时选择此 API。在每次请求中提供对话;响应不会存储以供后续检索。
发送请求#
cURL
curl --fail-with-body --request POST \
"https://api.shareai.now/api/v1/responses" \
-H "Authorization: Bearer $SHAREAI_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "YOUR_CHAT_MODEL",
"input": "Explain semantic search in two sentences.",
"instructions": "Use plain language.",
"store": false,
"stream": false
}'
Python
import json
import os
import urllib.request
headers = {"Authorization": "Bearer " + os.environ["SHAREAI_API_KEY"]}
headers["Content-Type"] = "application/json"
payload = {'model': 'YOUR_CHAT_MODEL', 'input': 'Explain semantic search in two sentences.', 'instructions': 'Use plain language.', 'store': False, 'stream': False}
data = json.dumps(payload).encode()
request = urllib.request.Request('https://api.shareai.now/api/v1/responses', data=data, headers=headers, method='POST')
with urllib.request.urlopen(request, timeout=60) as response:
print(json.load(response))
TypeScript
const url = "https://api.shareai.now/api/v1/responses";
const headers: Record = {
Authorization: `Bearer ${process.env.SHAREAI_API_KEY}`,
};
headers["Content-Type"] = "application/json";
const payload = {
"model": "YOUR_CHAT_MODEL",
"input": "Explain semantic search in two sentences.",
"instructions": "Use plain language.",
"store": false,
"stream": false
};
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify(payload) });
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
请求字段#
| 字段 | 价值 |
|---|---|
model | 一个由您的凭证允许的可用聊天模型。 |
input | 一个非空字符串,或最多 256 条文本消息。 |
instructions | 可选的系统指令添加到对话之前。 |
store | false;不支持存储响应。 |
stream | false 用于 JSON 或 true 用于响应 SSE 事件。 |
继续对话#
在 input 中发送较早的消息以及下一条用户消息。支持的角色是 user, assistant, system 和 developer。开发者指令在内部使用系统角色。消息内容可以是文本或 input_text/output_text 部分。
JSON
{
"model": "YOUR_CHAT_MODEL",
"input": [
{
"role": "user",
"content": "What is semantic search?"
},
{
"role": "assistant",
"content": "It finds results by meaning rather than exact words."
},
{
"role": "user",
"content": "Give one example."
}
],
"store": false
}
阅读结果#
JSON 响应是一个 response 对象。从 output[].content[] 类型的条目中读取助手文本。 output_text. 检查响应状态: completed 是一个完成的响应; incomplete 可以指示令牌限制。公共 usage 当前为 null;使用控制台使用情况检查处理的使用情况。
流式响应#
设置 stream: true 并解析 SSE。事件包括 response.created, response.output_text.delta 和一个终端 response.completed, response.incomplete 或 response.failed。按顺序追加文本增量并明确处理终端状态。
支持的子集#
此端点支持文本生成。存储的响应、 previous_response_id、检索/删除、工具、图像输入、后台请求和生成设置如 temperature 不支持并被拒绝。对于由 Chat Completions 支持的基于消息的生成设置,请使用 聊天完成.
使用 OAuth 访问令牌#
将 Authorization 头中的 API 密钥替换为已批准的 OAuth 访问令牌。 surcharge 账户资助的推理需要范围和接受的使用计划。仅身份范围无法授权支出。请参阅 范围和权限.
最近更新于 9 月 15, 2026