Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Create an assistant

For guidance and examples, see Create an assistant

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

POST /assistants

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • name (body, 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 '-'.
  • instructions (body, string) — Description or directive for the assistant to apply to all responses. Maximum 16 KB.
  • metadata (body, 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.
  • region (body, string) — The region to deploy the assistant in. Our current options are either us or eu. Defaults to us.
  • 200 — Create request successful.
  • 400 — Bad request. The request body included invalid request parameters.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 429 — Assistant of given name already exists.
  • 500 — Internal server error.
Suggest an edit

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

Export
Documentation menu