Modify Thread

POST /threads/{thread_id}

cURL

cURL

curl https://api.portkey.ai/v1/threads/thread_abc123 \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "OpenAI-Beta: assistants=v2" \
  -d '{
      "metadata": {
        "modified": "true",
        "user": "abc123"
      }
    }'

from portkey_ai import Portkey

client = Portkey(
  api_key = "PORTKEY_API_KEY",
  virtual_key = "PROVIDER_VIRTUAL_KEY"
)

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

import Portkey from 'portkey-ai';

const client = new Portkey({
  apiKey: 'PORTKEY_API_KEY',
  virtualKey: 'PROVIDER_VIRTUAL_KEY'
});

async function main() {
  const updatedThread = await client.beta.threads.update(
    "thread_abc123",
    {
      metadata: { modified: "true", user: "abc123" },
    }
  );

  console.log(updatedThread);
}

main();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.portkey.ai/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 => [
    "Content-Type: application/json",
    "x-portkey-api-key: <api-key>",
    "x-portkey-virtual-key: <api-key>"
  ],
]);

$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.portkey.ai/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("x-portkey-api-key", "<api-key>")
	req.Header.Add("x-portkey-virtual-key", "<api-key>")
	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.portkey.ai/v1/threads/{thread_id}")
  .header("x-portkey-api-key", "<api-key>")
  .header("x-portkey-virtual-key", "<api-key>")
  .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.portkey.ai/v1/threads/{thread_id}")

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

request = Net::HTTP::Post.new(url)
request["x-portkey-api-key"] = '<api-key>'
request["x-portkey-virtual-key"] = '<api-key>'
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

200

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

Authorizations

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NamePortkey-Key & ConfigPortkey-Key & Provider-Auth & Provider-Name & Custom-Host

x-portkey-api-key · string · header · required

x-portkey-virtual-key · string · header · required

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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

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. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.