Modify Thread

Supported Providers

• OpenAI

Modifies a thread.

post

Authorizations

Portkey-KeyVirtual-KeyProvider-AuthProvider-NameConfigCustom-Host

Path parameters

thread_idstringRequired

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

Body

metadataobject | nullableOptional

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.

Responses

200

OK

application/json

post

curlpythonjavascript

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"
      }
    }'

200

OK

{
  "id": "text",
  "object": "thread",
  "created_at": 1,
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "text"
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "text"
      ]
    }
  },
  "metadata": {}
}