Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Check assistant status

Get the status of an assistant.

For guidance and examples, see Manage assistants

curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"

curl -X GET "https://api.pinecone.io/assistant/assistants/$ASSISTANT_NAME" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2026-04"
curl
{
  "name": "example-assistant",
  "instructions": "Use American English for spelling and grammar.",
  "metadata": {"team": "customer-support", "version": "1.0"},
  "status": "Ready",
  "host": "https://prod-1-data.ke.pinecone.io",
  "created_at": "2025-10-01T12:30:00Z",
  "updated_at": "2025-10-01T12:45:00Z"
}

GET /assistants/{assistant_name}

Api-Keystringrequired

Pinecone API Key

Typestring
X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-04
assistant_namestringrequired

The name of the assistant to get a status on.

Typestring

200 — Poll 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

Guidance applied to all responses generated by the assistant.

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

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

The current operational status of the assistant.

Typestring
host?string

The host where the assistant is deployed.

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

Typestring
region?string

The region where the assistant is deployed.

Typestring
created_at?string

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

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

Typestring
updated_at?string

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

Typestring
Suggest an edit

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

Export
Documentation menu