Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1372170520.1 KB
Manage Assistants

Update an assistant

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

For guidance and examples, see Manage assistants.

patch/assistants/{assistant_name}

Path parameters

assistant_namestring required

The name of the assistant to update.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

instructionsstring nullable

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

metadataobject nullable

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

Example request

{
  "instructions": "Answer questions with clear, helpful answers. Keep the tone friendly and easy to follow.",
  "metadata": {
    "role": "Customer Support Helper",
    "team": "Operations"
  }
}

Response

Update request successful.

assistant_namestring

The assistant name.

instructionsstring

Guidance applied to all responses generated by the assistant.

metadataobject

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

Example response

{
  "instructions": "Answer questions with clear, helpful answers. Keep the tone friendly and easy to follow.",
  "metadata": {
    "role": "Customer Support Helper",
    "team": "Operations"
  }
}