Skip to main content
GET
/
assistants
/
{assistant_name}
# 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.describe_assistant(
    assistant_name="example-assistant", 
)

{
  "name": "example-assistant",
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {},
  "status": "Initializing",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt

Use this file to discover all available pages before exploring further.

# 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.describe_assistant(
    assistant_name="example-assistant", 
)

{
  "name": "example-assistant",
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {},
  "status": "Initializing",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z"
}

Authorizations

​
Api-Key
string
header
required

Pinecone API Key

Path Parameters

​
assistant_name
string
required

The name of the assistant to get a status on.

Response

Poll 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
Example:

"example-assistant"

​
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
​
host
string

The host where the assistant is deployed.

​
created_at
string<date-time>
​
updated_at
string<date-time>