Create an assistant
For guidance and examples, see Create an assistant
# To use the Python SDK, install the plugin:
# pip install --upgrade pinecone pinecone-plugin-assistant
from pinecone import Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")
assistant = pc.assistant.create_assistant(
assistant_name="example-assistant",
instructions="Use American English for spelling and grammar.",
region="us", # Region to deploy assistant. Options: "us" (default) or "eu".
timeout=30 # Maximum seconds to wait for assistant status to become "Ready" before timing out.
)import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' });
const assistant = await pc.createAssistant({
name: 'example-assistant',
instructions: 'Use American English for spelling and grammar.',
region: 'us'
});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-01" \
-d '{
"name": "example-assistant",
"instructions": "Use American English for spelling and grammar.",
"region":"us"
}'{
"name": "example-assistant",
"instructions": "Use American English for spelling and grammar.",
"metadata": {},
"status": "Initializing",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}POST /assistants
Authorizations
Section titled “Authorizations”Api-KeystringrequiredPinecone API Key
The desired configuration to create an assistant.
namestringrequiredThe name of the assistant. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
Required string length: 1 - 45. Example: example-assistant
instructions?string | nullDescription or directive for the assistant to apply to all responses.
metadata?objectregion?enum<string>The region to deploy the assistant in. Our current options are either us or eu. Defaults to us.
Available options: us, eu
Response
Section titled “Response”200 — Create request successful.
The AssistantModel describes the configuration and status of a Pinecone Assistant.
namestringrequiredThe name of the assistant. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
Required string length: 1 - 45. Example: example-assistant
instructions?string | nullDescription or directive for the assistant to apply to all responses.
metadata?object | nullstatusenum<string>requiredAvailable options: Initializing, Failed, Ready, Terminating
host?stringThe host where the assistant is deployed.
created_at?stringupdated_at?string