修改线程

Modifies a thread.

post

https://api.portkey.ai/v1SELF_HOSTED_GATEWAY_URL

/threads/{thread_id}

Authorizations

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NameConfig & Portkey-KeyCustom-Host & Portkey-Key & Provider-Auth & Provider-Name

x-portkey-api-keystringRequired

x-portkey-virtual-keystringRequired

Path parameters

thread_idstringRequired

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

Body

application/json

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

Represents a thread that contains messages.

idstringRequired

The identifier, which can be referenced in API endpoints.

objectstring · enumRequired

The object type, which is always thread.

Possible values:

created_atintegerRequired

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

metadataobject · nullableRequired

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.

post

/threads/{thread_id}

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": {}
}