Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Update an assistant

Update an existing assistant. You can modify the assistant's instructions.

For guidance and examples, see Manage assistants.

curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"

curl -X PATCH "https://api.pinecone.io/assistant/assistants/$ASSISTANT_NAME" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Pinecone-Api-Version: 2026-04" \
  -d '{
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {"team": "customer-support", "version": "1.1"}
}'
curl
{
  "name": "example-assistant",
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {"team": "customer-support", "version": "1.1"},
  "status": "Ready",
  "host": "https://prod-1-data.ke.pinecone.io",
  "created_at": "2025-10-01T12:30:00Z",
  "updated_at": "2025-10-01T12:45:00Z"
}

PATCH /assistants/{assistant_name}

Api-Keystringrequired

Pinecone API Key

Typestring
X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-04
assistant_namestringrequired

The name of the assistant to update.

Typestring

The desired configuration updates for the assistant.

instructions?string | null

Guidance applied to all responses generated by the assistant. Maximum 16 KB.

Example: Answer questions with clear, helpful answers. Keep the tone friendly and easy to follow.

Typestring | null
metadata?object | null

Optional metadata associated with the assistant. Metadata is a JSON object that can store custom organizational data, tags, and attributes. Maximum size is 16KB.

Typeobject | null

200 — Update request successful.

assistant_name?string

The assistant name.

Typestring
instructions?string

Guidance applied to all responses generated by the assistant.

Example: Answer questions with clear, helpful answers. Keep the tone friendly and easy to follow.

Typestring
metadata?object

Optional metadata associated with the assistant. Metadata is a JSON object that can store custom organizational data, tags, and attributes.

Typeobject
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu