アシスタントを作ります

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

model

string

required

要使用的模型的 ID。您可以使用列表模型API 查看所有可用模型，或查看我们的模型概述以获取它们的描述。

name

string

optional

助理的名字。最大长度为 256 个字符。

description

string

optional

助理的描述。最大长度为 512 个字符。

instructions

string

optional

助手使用的系统指令。最大长度为 32768 个字符。

tools

array [object {1}]

optional

助手上启用的工具列表。每个助手最多可以有 128 个工具。工具的类型可以是code_interpreter、retrieval、或function。

type

string

optional

正在定义的工具类型：code_interpreter

file_ids

array[string]

optional

附加到该助手的文件ID列表。助手最多可以附加 20 个文件。文件按其创建日期升序排列。

metadata

object

optional

一组可附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息非常有用。键的最大长度为 64 个字符，值的最大长度为 512 个字符。

Example

{
    "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
    "name": "Math Tutor"
    "tools": [{"type": "code_interpreter"}],
    "model": "gpt-4"
  }

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.openai.com/v1/assistants' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
    "name": "Math Tutor"
    "tools": [{"type": "code_interpreter"}],
    "model": "gpt-4"
  }'

Responses

🟢200成功

application/json

Body

id

string

required

object

string

required

created_at

integer

required

name

string

required

description

null

required

model

string

required

instructions

string

required

tools

array [object {1}]

required

type

string

optional

file_ids

array[string]

required

metadata

object

required

Example

{
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1698984975,
  "name": "Math Tutor",
  "description": null,
  "model": "gpt-4",
  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "file_ids": [],
  "metadata": {}
}