创建消息 - OpenAI API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

thread_id

string

required

要为其创建消息的线程的 ID 。

Body Params application/json

role

string

required

创建消息的实体的角色。目前仅user支持。

content

string

required

消息的内容。

file_ids

array[string]

optional

消息应使用的文件ID列表。一条消息最多可以附加 10 个文件。retrieval对于code_interpreter可以访问和使用文件的工具非常有用。

metadata

object

optional

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

Example

{
  "role": "user",
  "content": "How does AI work? Explain it in simple terms."
}

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/threads//messages' \
--header 'Content-Type: application/json' \
--data-raw '{
      "role": "user",
      "content": "How does AI work? Explain it in simple terms."
    }'

Responses

🟢200成功

application/json

Body

id

string

required

标识符，可以在 API 端点中引用。

object

string

required

对象类型，始终为thread.message。

created_at

integer

required

创建消息时的 Unix 时间戳（以秒为单位）。

thread_id

string

required

该消息所属的线程ID 。

role

string

required

产生消息的实体。user或之一assistant。

content

array [object {2}]

required

文本和/或图像数组中的消息内容。

type

string

optional

总是image_file。

text

object

optional

作为消息一部分的文本内容。

file_ids

array[string]

required

助手应使用的文件ID列表。对于可访问文件的检索和 code_interpreter 等工具很有用。一条消息最多可以附加 10 个文件。

assistant_id

null

required

如果适用，则为创作此消息的助理的 ID 。

run_id

null

required

如果适用，与此消息的创作关联的运行的 ID 。

metadata

object

required

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

Example

{
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1699017614,
  "thread_id": "thread_abc123",
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "How does AI work? Explain it in simple terms.",
        "annotations": []
      }
    }
  ],
  "file_ids": [],
  "assistant_id": null,
  "run_id": null,
  "metadata": {}
}