Managing Assistants & Threads

概述

Threads （线程） 和 Messages （消息） 表示 Assistant 与用户之间的对话会话。您可以在 Thread 中存储的消息数量没有限制。当 Messages 的大小超过模型的上下文窗口时，Thread 将在完全删除最不重要的消息之前巧妙地截断消息。

API 参考

删除助手。

delete

删除助手，将其从系统中删除。

路径参数

assistantIdstring必填

响应

200成功

application/json

delete

/assistants/{assistantId}

HTTPcURLJavaScriptPython

DELETE /assistants/{assistantId} HTTP/1.1
Host: api.aimlapi.com
Accept: */*

200成功

{
  "id": "text",
  "object": "assistant.deleted",
  "deleted": true
}

创建新助手。

post

创建新的 AI 助手，将其配置为根据预定义的模型和设置执行任务。

请求体

application/json

namestring必填

descriptionstring必填

modelstring必填

instructionsstring可选

metadataobject可选

响应

201成功

application/json

idstring必填

created_atnumber必填

descriptionstring · 可为 null必填

instructionsstring · 可为 null必填

metadataany · 可为 null可选

modelstring必填

namestring · 可为 null必填

objectstring · enum必填可能的值:

response_formatany of可选

或

或

any · 可为 null可选

temperaturenumber · 最大值: 2 · 可为 null可选

tool_resourcesany可选

top_pnumber · 最大值: 1 · 可为 null可选

post

/assistants

HTTPcURLJavaScriptPython

POST /assistants HTTP/1.1
Host: api.aimlapi.com
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "text",
  "description": "text",
  "model": "text",
  "instructions": "text",
  "metadata": {}
}

201成功

{
  "id": "text",
  "created_at": 1,
  "description": "text",
  "instructions": "text",
  "metadata": null,
  "model": "text",
  "name": "text",
  "object": "assistant",
  "tools": [],
  "response_format": {
    "type": "json_schema",
    "json_schema": {}
  },
  "temperature": 1,
  "tool_resources": null,
  "top_p": 1
}

列出全部可用的模型

get

返回一个可用的AI助手列表，使用户可以查看和管理他们的虚拟助手。

查询参数

limitnumber可选

orderstring可选

beforestring可选

afterstring可选

响应

200成功

application/json

get

/assistants

HTTPcURLJavaScriptPython

GET /assistants HTTP/1.1
Host: api.aimlapi.com
Accept: */*

200成功

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "created_at": 1,
      "description": "text",
      "instructions": "text",
      "metadata": null,
      "model": "text",
      "name": "text",
      "object": "assistant",
      "tools": [],
      "response_format": {
        "type": "json_schema",
        "json_schema": {}
      },
      "temperature": 1,
      "tool_resources": null,
      "top_p": 1
    }
  ]
}

获取特定助理的详细信息。

get

检索有关特定助手的信息，包括其当前配置和状态。

路径参数

assistantIdstring必填

响应

200成功

application/json

get

/assistants/{assistantId}

HTTPcURLJavaScriptPython

GET /assistants/{assistantId} HTTP/1.1
Host: api.aimlapi.com
Accept: */*

200成功

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "created_at": 1,
      "description": "text",
      "instructions": "text",
      "metadata": null,
      "model": "text",
      "name": "text",
      "object": "assistant",
      "tools": [],
      "response_format": {
        "type": "json_schema",
        "json_schema": {}
      },
      "temperature": 1,
      "tool_resources": null,
      "top_p": 1
    }
  ]
}

更新助手的设置。

post

更新现有助手的配置或设置。

路径参数

assistantIdstring必填

请求体

application/json

namestring可选

descriptionstring可选

modelstring可选

instructionsstring可选

metadataobject可选

响应

200成功

application/json

post

/assistants/{assistantId}

HTTPcURLJavaScriptPython

POST /assistants/{assistantId} HTTP/1.1
Host: api.aimlapi.com
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "text",
  "description": "text",
  "model": "text",
  "instructions": "text",
  "metadata": {}
}

200成功

{
  "id": "text",
  "created_at": 1,
  "description": "text",
  "instructions": "text",
  "metadata": null,
  "model": "text",
  "name": "text",
  "object": "assistant",
  "tools": [],
  "response_format": {
    "type": "json_schema",
    "json_schema": {}
  },
  "temperature": 1,
  "tool_resources": null,
  "top_p": 1
}