MiniMax
  1. Assistant
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
          POST
        • 检索 Assistants
          GET
        • 删除 assistant
          POST
        • 查看 assistant 列表
          GET
      • Assistant File
        • 创建 assistant 文件
        • 检索 assistant 关联的文件
        • 列出 assistant 文件
      • Thread
        • 创建 thread
        • 检索 thread
      • Message
        • 创建 message
        • 检索 message
        • message 列表
      • Run
        • 创建 run
        • 检索 run
        • 列表 run
        • Submit tool outputs to run
      • 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. Assistant

检索 Assistants

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/v1/assistants/retrieve
您可以通过此项操作检索已创建的 assistant。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://dev-cn.your-api-server.com/v1/assistants/retrieve?GroupId=${GroupId}&assistant_id=${Assistant_Id}' \
--header 'Authorization: Bearer ${API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw ''
响应示例响应示例
{
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1703228868,
  "name": "function",
  "description": "代码机器人",
  "model": "my_model",
  "instructions": "Follow the instructions carefully",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "get weather",
        "parameters": {
          "type": "object",
          "required": [
            "city"
          ],
          "properties": {
            "city": {
              "type": "string"
            }
          }
        }
      }
    },
    {
      "type": "web_search"
    },
    {
      "type": "retrieval"
    }
  ],
  "file_ids": [
    "file-abc123",
    "file-abc456"
  ],
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "rolemeta": {},
  "status": "available",
  "base_resp": {
    "status_code": 0,
    "status_msg": "success"
  }
}

请求参数

Query 参数
GroupId
string 
必需
用户所属的组(该值应拼接在调用API的url末尾)
示例值:
${GroupId}
assistant_id
string 
必需
示例值:
${Assistant_Id}
Header 参数
Authorization
string 
必需
示例值:
Bearer ${API_KEY}
Content-Type
string 
必需
示例值:
application/json

返回响应

🟢200成功
application/json
Body
id
string 
必需
object
string 
对象
必需
created_at
integer 
创建时间
必需
name
string 
assistant代称
必需
最大长度为 256 个字符
description
string 
assistant描述
必需
model
string 
调用的算法模型
必需
可选项: abab5.5 finetune model
instructions
string 
assistant的指令
必需
长度上限为16384个字符。 具体限制需要根据所选模型调整
tools
array [object {2}] 
assistant启用的工具列表
必需
默认[] 列表上限为128个
type
string 
工具类型
必需
可选项: code_interpreter retrieval function web_search
function
object 
仅当工具类型为function时补充
可选
参数 description str name str parameters object
file_ids
array[string]
assistant关联的文件
必需
默认[] 最多上传20个
metadata
object 
必需
key1
string 
必需
key2
string 
必需
rolemeta
object 
必需
status
string 
assistant状态
必需
available-可用
base_resp
object 
错误状态码和详情
必需
status_code
integer 
状态码
必需
1000,未知错误 1001,超时 1002,触发RPM限流 1004,鉴权失败 1008,余额不足 1013,服务内部错误 1027,输出内容错误 1039,触发TPM限流 2013,输入格式信息不正常
status_msg
string 
错误详情
必需
上一页
创建 Assistant
下一页
删除 assistant
Built with