MiniMax
  1. Run
MiniMax
  • 公告通知
  • 产品定价
  • 概述
  • FAQ
  • 大模型介绍
    • 文本大模型
    • 语音大模型
  • 接入说明
    • 新手指南
    • 速率说明
  • 开发指南
    • 快速开始
  • 文本大模型接口
    • ChatCompletion Pro(对话)
      • 概述
      • ChatCompletion Pro API 文档
        • ChatCompletion Pro API
        • 示例对话功能
        • 限制返回格式功能(glyph)
        • 函数调用功能(function calling)
        • 插件功能(plugins)
        • 知识库检索功能(retrieval)
    • ChatCompletion(对话)
      • 概述
      • ChatCompletion 快速接入
      • ChatCompletion 调优指南
      • ChatCompletion API 文档
        • ChatCompletion API
        • 知识库检索功能(retrieval)
  • Assistants 接口
    • Assistants 操作指南
    • Assistans API 文档
      • Assistant
        • 创建 Assistant
        • 检索 Assistants
        • 删除 assistant
        • 查看 assistant 列表
      • Assistant File
        • 创建 assistant 文件
        • 检索 assistant 关联的文件
        • 列出 assistant 文件
      • Thread
        • 创建 thread
        • 检索 thread
      • Message
        • 创建 message
        • 检索 message
        • message 列表
      • Run
        • 创建 run
          POST
        • 检索 run
          GET
        • 列表 run
          GET
        • Submit tool outputs to run
          POST
      • Run Step
        • 检索 run step
        • 列表 run step
  • File(文档)
    • File(文档)
      GET
    • Upload 接口
      GET
    • Retrieve 接口
      GET
    • Delete 接口
      POST
    • RetrieveContent 接口
      GET
  • Retrieval(知识库检索)
    • 新建知识库
    • 删除知识库
    • 查看知识库详情
    • 查看知识库列表
    • 增加知识库文档
    • 删除知识库文档
    • 修改知识库文档
    • 查看知识库文档
    • 检索 Chatcompletion
    • 检索 Chatcompletion pro
  • 微调
    • Finetune 操作指南
    • Finetune API文档
      • 创建微调任务
      • 列出微调任务
      • 检索微调任务
      • 删除微调任务
      • 列出微调事件
      • 列举微调模型
      • 查询微调模型
      • 删除微调模型
  • 向量化
    • Embeddings(向量化)
  • 语音大模型接口
    • T2A (语音生成)
      • T2A 快速接入
      • T2A API 接口
        • T2A API接口
        • 字典功能(Dictionary)
    • T2A pro(长文本语音生成)
      • T2A Pro 快速接入
      • T2A Pro API 接口
      • 字典功能(Dictionary)
    • T2A large(异步超长文本语音生成)
      • T2A Large 快速接入
      • T2A Large API 接口
        • T2A Large API 接口
        • 字典功能(Dictionary)
    • T2A Stream(流式语音生成)
      • T2A Stream(流式语音生成)
      • 字典功能(Dictionary)
    • 快速复刻(Voice Cloning)
      • 上传文件
      • 音频复刻
  • 有声内容创作
    • Role Classification (文本角色分类)
      • 创建并异步运行角色识别任务
      • 查询角色识别任务
    • Role Audio Generation (角色音频生成)
      • 角色音频生成
  1. Run

创建 run

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v1/threads/run/create
Error结构
参数类型含义
codestring错误码
messagestring错误信息
Function结构
参数类型含义备注
namestring函数名称
descriptionstring函数功能描述
parametersFunctionParameters该函数的参数及其说明对每个参数的命名和参数说明也需要描述精确,才能更好的生成。比如: "parameters": { "type": "object", "properties": { "meeting_id": { "type": "string", "description": "会议id" }, "participants": { "type": "string", "description": "参会人" } }, "required": [ "meetingid", "participants" ] }
您可以通过此项操作创建一个Run。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://dev-cn.your-api-server.com/v1/threads/run/create?GroupId=${GroupId}' \
--header 'Authorization: Bearer ${API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thread_id": "$Thread_Id",
    "assistant_id": "${Assistant_Id}"
}'
响应示例响应示例
{
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1703245668,
    "assistant_id": "asst_abc123
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 0,
    "expires_at": 0,
    "cancelled_at": 0,
    "failed_at": 0,
    "completed_at": 0,
    "last_error": null,
    "model": "abab5.5-chat",
    "instructions": "Follow the instructions carefully\n回答中若参考了函数返回结果中的信息,请在该句末尾用【1†source】【2†source】【3†source】的形式标注信息来源。严禁使用其他的引用格式(如[1],【1】,²等等)。",
    "tools": [
        {
            "type": "retrieval"
        }
    ],
    "file_ids": [
        "${file id}"
    ],
    "metadata": null,
    "base_resp": {
        "status_code": 0,
        "status_msg": "success"
    }
}

请求参数

Query 参数
GroupId
string 
必需
示例值:
${GroupId}
Header 参数
Authorization
string 
必需
示例值:
Bearer ${API_KEY}
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
thread_id
string 
必需
assistant_id
string 
必需
示例

返回响应

🟢200成功
application/json
Body
id
string 
Run id
必需
object
string 
对象:run
必需
created_at
integer 
创建时间戳
必需
assistant_id
string 
必需
对应assistantassistantid
thread_id
string 
必需
status
string 
状态
必需
started_at
integer 
开始运行时间戳
必需
expires_at
integer 
过期时间戳
必需
cancelled_at
integer 
取消时间戳
必需
failed_at
integer 
失败时间戳
必需
completed_at
integer 
成功时间戳
必需
last_error
null 
错误信息
必需
model
string 
模型名称
必需
instructions
string 
必需
覆盖assistiant的指令集
tools
array [object {1}] 
必需
可选项: code_interpreter retrieval function web_search
type
string 
可选
参数 description str name str parameters object
file_ids
array[string]
相关的文件列表
必需
metadata
null 
元信息
必需
base_resp
object 
必需
status_code
integer 
必需
status_msg
string 
必需
上一页
message 列表
下一页
检索 run
Built with