Oapi接口文档
  1. 运行(Runs)
Oapi接口文档
  • 介绍
  • 项目说明
  • 导言
  • 身份验证
  • 发出请求
  • 参数详情
  • oapi专属接口
    • 返回价格列表
      GET
    • 模型厂家接口
      GET
    • 获取指定日期使用量
      GET
    • 获取可使用模型
      GET
    • Gemini原生接口
      POST
    • Claude原生接口
      POST
  • 聊天(Chat)
    • 聊天完成对象
    • 聊天完成块对象
    • 创建聊天补全
      POST
  • 音频(Audio)
    • 创建语音
      GET
    • 创建转录
      GET
    • 创建翻译
      GET
  • 自动补全(Completions)
    • 完成对象
    • 创建完成
  • 嵌入(Embeddings)
    • 嵌入对象
    • 创建嵌入
  • 微调(Fine-tuning)
    • 微调作业对象
    • 微调作业事件对象
    • 创建微调作业
    • 列出微调作业
    • 检索微调作业
    • 取消微调
    • 列出微调事件
  • 图像(Images)
    • README
    • 图像对象
    • 创建图像
    • 创建图片编辑
    • 创建图像变体
  • 模型(Models)
    • 模型对象
    • 列出模型
    • 检索模型
    • 删除微调模型
  • 文件(Files)
    • README
    • 文件对象
    • 上传文件
    • 删除文件
    • 检索文件
    • 检索文件内容
    • 列出文件
  • 审查(Moderations)
    • 调节对象
    • 创建内容审核
  • 助手测试版(AssistantsBeta)
    • 辅助对象
    • 辅助文件对象
    • 创建助手
    • 检索助手
    • 修改助手
    • 删除助手
    • 列出助手
    • 创建辅助文件
    • 检索助手文件
    • 删除辅助文件
    • 列出助手文件
  • 线程数(Threads)
    • 线程对象
    • 创建线程
    • 检索线程
    • 修改线程
    • 删除话题
  • 留言(Messages)
    • 消息对象
    • 消息文件对象
    • 创建消息
    • 检索消息
    • 修改留言
    • 列出消息
    • 检索消息文件
    • 列出消息文件
  • 运行(Runs)
    • 运行对象
    • 运行步骤对象
    • 创建运行
      POST
    • 检索运行
      GET
    • 修改运行
      GET
    • 列表运行
      GET
    • 提交工具输出以运行
      POST
    • 取消运行
      POST
    • 创建线程并运行
      POST
    • 检索运行步骤
      GET
    • 列出运行步骤
      GET
  • 已弃用-音频(Audio)
    • 创建转录
    • 创建翻译
  1. 运行(Runs)

创建线程并运行

开发中
POST
/v1/threads/runs
创建一个线程并在一个请求中运行它。
一个运行对象。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
assistant_id
string 
必需
用于执行此运行的助手的 ID 。
thread
object 
必需
messages
array [object {4}] 
可选
用于启动线程的消息列表。
metadata
object 
可选
一组可附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息非常有用。键的最大长度为 64 个字符,值的最大长度为 512 个字符。
model
string 
可选
用于执行此运行的模型的 ID 。如果此处提供了值,它将覆盖与助手关联的模型。如果没有,将使用与助手关联的模型。
instructions
string 
可选
覆盖助手的默认系统消息。这对于修改每次运行的行为非常有用。
tools
array[string]
可选
覆盖助手可用于此运行的工具。这对于修改每次运行的行为非常有用。
metadata
string 
可选
一组可附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息非常有用。键的最大长度为 64 个字符,值的最大长度为 512 个字符。
示例
{
  "assistant_id": "asst_IgmpQTah3ZfPHCVZjTqAY8Kv",
  "thread": {
    "messages": [
      {
        "role": "user",
        "content": "Explain deep learning to a 5 year old."
      }
    ]
  }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://oapi.czl.net/v1/threads/runs' \
--header 'Content-Type: application/json' \
--data-raw '{
      "assistant_id": "asst_IgmpQTah3ZfPHCVZjTqAY8Kv",
      "thread": {
        "messages": [
          {"role": "user", "content": "Explain deep learning to a 5 year old."}
        ]
      }
    }'

返回响应

🟢200成功
application/json
Body
id
string 
必需
object
string 
必需
created_at
integer 
必需
assistant_id
string 
必需
thread_id
string 
必需
status
string 
必需
started_at
null 
必需
expires_at
integer 
必需
cancelled_at
null 
必需
failed_at
null 
必需
completed_at
null 
必需
last_error
null 
必需
model
string 
必需
instructions
string 
必需
tools
array[string]
必需
file_ids
array[string]
必需
metadata
object 
必需
示例
{
  "id": "run_3Qudf05GGhCleEg9ggwfJQih",
  "object": "thread.run",
  "created_at": 1699076792,
  "assistant_id": "asst_IgmpQTah3ZfPHCVZjTqAY8Kv",
  "thread_id": "thread_Ec3eKZcWI00WDZRC7FZci8hP",
  "status": "queued",
  "started_at": null,
  "expires_at": 1699077392,
  "cancelled_at": null,
  "failed_at": null,
  "completed_at": null,
  "last_error": null,
  "model": "gpt-4",
  "instructions": "You are a helpful assistant.",
  "tools": [],
  "file_ids": [],
  "metadata": {}
}
修改于 2024-01-08 06:38:13
上一页
取消运行
下一页
检索运行步骤
Built with