创建线程并运行

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

assistant_id

string

required

用于执行此运行的助手的 ID 。

thread

object

required

messages

array [object {4}]

optional

用于启动线程的消息列表。

metadata

object

optional

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

model

string

optional

用于执行此运行的模型的 ID 。如果此处提供了值，它将覆盖与助手关联的模型。如果没有，将使用与助手关联的模型。

instructions

string

optional

覆盖助手的默认系统消息。这对于修改每次运行的行为非常有用。

tools

array[string]

optional

覆盖助手可用于此运行的工具。这对于修改每次运行的行为非常有用。

metadata

string

optional

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

Example

{
  "assistant_id": "asst_IgmpQTah3ZfPHCVZjTqAY8Kv",
  "thread": {
    "messages": [
      {
        "role": "user",
        "content": "Explain deep learning to a 5 year old."
      }
    ]
  }
}

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/runs' \
--header 'Content-Type: application/json' \
--data-raw '{
      "assistant_id": "asst_IgmpQTah3ZfPHCVZjTqAY8Kv",
      "thread": {
        "messages": [
          {"role": "user", "content": "Explain deep learning to a 5 year old."}
        ]
      }
    }'

Responses

🟢200成功

application/json

Body

id

string

required

object

string

required

created_at

integer

required

assistant_id

string

required

thread_id

string

required

status

string

required

started_at

null

required

expires_at

integer

required

cancelled_at

null

required

failed_at

null

required

completed_at

null

required

last_error

null

required

model

string

required

instructions

string

required

tools

array[string]

required

file_ids

array[string]

required

metadata

object

required

Example

{
  "id": "string",
  "object": "string",
  "created_at": 0,
  "assistant_id": "string",
  "thread_id": "string",
  "status": "string",
  "started_at": null,
  "expires_at": 0,
  "cancelled_at": null,
  "failed_at": null,
  "completed_at": null,
  "last_error": null,
  "model": "string",
  "instructions": "string",
  "tools": [
    "string"
  ],
  "file_ids": [
    "string"
  ],
  "metadata": {}
}