Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Create an assistant

For guidance and examples, see Create an assistant

curl
PINECONE_API_KEY="YOUR_API_KEY"

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

POST /assistants

Api-Keystringrequired

Pinecone API Key

Typestring
X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2025-10

The desired configuration to create an assistant.

namestringrequired

The name of the assistant. Resource name must be 1-63 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 63. Example: example-assistant

Typestring
instructions?string | null

Description or directive for the assistant to apply to all responses. Maximum 16 KB.

Typestring | null
metadata?object

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
region?string

The region to deploy the assistant in. Our current options are either us or eu. Defaults to us.

Typestring

200 — Create request successful.

Describes the configuration and status of a Pinecone Assistant.

namestringrequired

The name of the assistant. Resource name must be 1-63 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 63. Example: example-assistant

Typestring
instructions?string | null

Description or directive for the assistant to apply to all responses.

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.

Typeobject | null
statusstringrequired
host?string

The host where the assistant is deployed.

Typestring
created_at?string
updated_at?string
Suggest an edit

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

Export
Documentation menu