Authentication
Authenticate to the Nexus API with your Pinecone API key, sent directly or exchanged for a short-lived session token.
All requests to the Pinecone Nexus API authenticate with a valid Pinecone API key for the target project. The Pinecone project is the tenancy boundary. How you send the key depends on the plane:
- Control plane (workspace management,
https://api.pinecone.io): send the key directly in theApi-Keyheader. - Data plane (contexts, curation, and queries, your workspace host): exchange the key for a short-lived session token with
POST /auth/login, or send it directly in theApi-Keyheader.
Get an API key
Section titled “Get an API key”Create an API key in the Pinecone console.
export PINECONE_API_KEY="YOUR_API_KEY"Control plane
Section titled “Control plane”The control plane is served at https://api.pinecone.io. Send your Pinecone API key directly in the Api-Key header, with no login exchange.
curl -fsS "https://api.pinecone.io/workspaces" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'X-Pinecone-Api-Version: 2026-07'Data plane
Section titled “Data plane”The data plane is served at your deployment's workspace host, from the nexus_default_workspace_data_console_url output of the install:
export NEXUS_BASE_URL="https://YOUR_WORKSPACE_HOST/api"Session token
Section titled “Session token”The primary method for data-plane requests. Exchange your API key for a short-lived bearer token with POST /auth/login, then send that token as Authorization: Bearer <token> on every request.
export NEXUS_TOKEN="$(
curl -fsS "$NEXUS_BASE_URL/auth/login" \
-H 'Content-Type: application/json' \
-H 'X-Pinecone-Api-Version: 2026-07' \
-d "{\"api_key\":\"$PINECONE_API_KEY\"}" \
| jq -r '.token'
)"
curl -fsS "$NEXUS_BASE_URL/contexts" \
-H "Authorization: Bearer $NEXUS_TOKEN" \
-H 'X-Pinecone-Api-Version: 2026-07'API key
Section titled “API key”Alternatively, send your Pinecone API key directly in the Api-Key header, with no login exchange.
curl -fsS "$NEXUS_BASE_URL/contexts" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'X-Pinecone-Api-Version: 2026-07'