POST
/
assistants
# 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.
)

{
  "name": "example-assistant",
  "instructions": "<string>",
  "metadata": {},
  "status": "Initializing",
  "host": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
# 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.
)

Authorizations

​
Api-Key
string
header
required

Pinecone API Key

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-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Required string length: 1 - 45
​
instructions
string | null

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

​
metadata
object
​
region
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

200
application/json
Create request successful.

The AssistantModel describes the configuration and status of a Pinecone Assistant.

​
name
string
required

The 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
​
status
enum<string>
required
Available options:
Initializing,
Failed,
Ready,
Terminating
​
instructions
string | null

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

​
metadata
object | null
​
host
string

The host where the assistant is deployed.

​
created_at
string
​
updated_at
string

Was this page helpful?

List assistantsCheck assistant status