Modify thread (v1)

POST

https://api.openai.com/v1/threads/thread_abc123

Modifies a thread.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.openai.com/v1/threads/thread_abc123' \
--header 'Authorization: Bearer $OPENAI_API_KEY' \
--header 'OpenAI-Beta: assistants=v1' \
--header 'Content-Type: application/json' \
--data-raw '{
      "metadata": {
        "modified": "true",
        "user": "abc123"
      }
    }'

Response Example

{
  "id": "thread_abc123",
  "object": "thread",
  "created_at": 1699014083,
  "metadata": {
    "modified": "true",
    "user": "abc123"
  }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer $OPENAI_API_KEY

OpenAI-Beta

string

required

Example:

assistants=v1

Body Params application/json

metadata

object

required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

modified

string

required

user

string

required

Examples

Responses

🟢200Success

application/json

Body

string

required

object

string

required

created_at

integer

required

metadata

object

required

modified

string

required

user

string

required

Modified at 2024-12-12 08:32:14

Retrieve thread (v1)

Delete thread (v1)