Skip to main content
POST
/
assistants
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: 2026-04" \
  -d '{
  "name": "example-assistant",
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {"team": "customer-support", "version": "1.0"},
  "region":"us"
}'

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

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: 2026-04" \
  -d '{
  "name": "example-assistant",
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {"team": "customer-support", "version": "1.0"},
  "region":"us"
}'

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

Authorizations

​
Api-Key
string
header
required

Pinecone API Key

Headers

​
X-Pinecone-Api-Version
string
default:2026-04
required

Required date-based version header

Body

application/json

The desired configuration to create an assistant.

The configuration needed to create an assistant.

​
name
string
required

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"

​
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."

​
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.

Example:
{
  "role": "Customer Support Helper",
  "team": "Operations"
}
​
region
string

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

Response

Create request successful.

Describes the configuration and status of a Pinecone Assistant.

​
name
string
required

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"

​
status
string
required

The current operational status of the assistant.

​
instructions
string | null

Guidance applied to all responses generated by the assistant.

Example:

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

​
metadata
object

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

Example:
{
  "role": "Customer Support Helper",
  "team": "Operations"
}
​
host
string

The host where the assistant is deployed.

Example:

"https://prod-1-data.ke.pinecone.io"

​
region
string

The region where the assistant is deployed.

​
created_at
string<date-time>

The timestamp when the assistant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2025-10-01T12:30:00.000Z"

​
updated_at
string<date-time>

The timestamp of the most recent update to the assistant, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2025-10-01T12:45:00.000Z"