Modify thread - OpenAI

Modify thread

curl --request POST \
  --url https://api.openai.com/v1/threads/{thread_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "<string>"
      ]
    }
  },
  "metadata": {}
}
'

import requests

url = "https://api.openai.com/v1/threads/{thread_id}"

payload = {
    "tool_resources": {
        "code_interpreter": { "file_ids": [] },
        "file_search": { "vector_store_ids": ["<string>"] }
    },
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tool_resources: {
      code_interpreter: {file_ids: []},
      file_search: {vector_store_ids: ['<string>']}
    },
    metadata: {}
  })
};

fetch('https://api.openai.com/v1/threads/{thread_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openai.com/v1/threads/{thread_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tool_resources' => [
        'code_interpreter' => [
                'file_ids' => [
                                
                ]
        ],
        'file_search' => [
                'vector_store_ids' => [
                                '<string>'
                ]
        ]
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openai.com/v1/threads/{thread_id}"

	payload := strings.NewReader("{\n  \"tool_resources\": {\n    \"code_interpreter\": {\n      \"file_ids\": []\n    },\n    \"file_search\": {\n      \"vector_store_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.openai.com/v1/threads/{thread_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tool_resources\": {\n    \"code_interpreter\": {\n      \"file_ids\": []\n    },\n    \"file_search\": {\n      \"vector_store_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openai.com/v1/threads/{thread_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tool_resources\": {\n    \"code_interpreter\": {\n      \"file_ids\": []\n    },\n    \"file_search\": {\n      \"vector_store_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "thread",
  "created_at": 123,
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "<string>"
      ]
    }
  },
  "metadata": {}
}

POST

/

threads

/

{thread_id}

Modify thread

curl --request POST \
  --url https://api.openai.com/v1/threads/{thread_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "<string>"
      ]
    }
  },
  "metadata": {}
}
'

import requests

url = "https://api.openai.com/v1/threads/{thread_id}"

payload = {
    "tool_resources": {
        "code_interpreter": { "file_ids": [] },
        "file_search": { "vector_store_ids": ["<string>"] }
    },
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tool_resources: {
      code_interpreter: {file_ids: []},
      file_search: {vector_store_ids: ['<string>']}
    },
    metadata: {}
  })
};

fetch('https://api.openai.com/v1/threads/{thread_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openai.com/v1/threads/{thread_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tool_resources' => [
        'code_interpreter' => [
                'file_ids' => [
                                
                ]
        ],
        'file_search' => [
                'vector_store_ids' => [
                                '<string>'
                ]
        ]
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openai.com/v1/threads/{thread_id}"

	payload := strings.NewReader("{\n  \"tool_resources\": {\n    \"code_interpreter\": {\n      \"file_ids\": []\n    },\n    \"file_search\": {\n      \"vector_store_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.openai.com/v1/threads/{thread_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tool_resources\": {\n    \"code_interpreter\": {\n      \"file_ids\": []\n    },\n    \"file_search\": {\n      \"vector_store_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openai.com/v1/threads/{thread_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tool_resources\": {\n    \"code_interpreter\": {\n      \"file_ids\": []\n    },\n    \"file_search\": {\n      \"vector_store_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "thread",
  "created_at": 123,
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "<string>"
      ]
    }
  },
  "metadata": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

thread_id

string

required

The ID of the thread to modify. Only the metadata can be modified.

Body

application/json

tool_resources

object | null

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Show child attributes

metadata

object | null

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Show child attributes

Response

200 - application/json

OK

Represents a thread that contains messages.

id

string

required

The identifier, which can be referenced in API endpoints.

object

enum<string>

required

The object type, which is always thread.

Available options:

thread

created_at

integer

required

The Unix timestamp (in seconds) for when the thread was created.

tool_resources

object | null

required

A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Show child attributes

metadata

object | null

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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Show child attributes