Exchange a Pinecone API key for a session token

curl --request POST \
  --url https://{host}/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>"
}
'

import requests

url = "https://{host}/api/auth/login"

payload = { "api_key": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({api_key: '<string>'})
};

fetch('https://{host}/api/auth/login', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/auth/login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'api_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/auth/login"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/auth/login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"api_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "token": "<string>",
  "principal": "<string>",
  "project_id": "<string>",
  "project_name": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

POST

auth

Exchange a Pinecone API key for a session token

curl --request POST \
  --url https://{host}/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>"
}
'

import requests

url = "https://{host}/api/auth/login"

payload = { "api_key": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({api_key: '<string>'})
};

fetch('https://{host}/api/auth/login', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/auth/login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'api_key' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/auth/login"

	payload := strings.NewReader("{\n  \"api_key\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/auth/login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"api_key\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "token": "<string>",
  "principal": "<string>",
  "project_id": "<string>",
  "project_name": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

Headers

X-Pinecone-Api-Version

string

default:2026-07

Date-based contract version, echoed back on the same header. Omit for the default (2026-07); send unstable for the in-development surface. An unrecognized value is rejected with 400 unsupported_api_version.

Body

application/json

The key to exchange. May be omitted where the deployment supplies its own.

api_key

string

Pinecone API key. Optional — when absent, the server falls back to its configured key (managed) or validates the seeded credential (BYOC).

Response

Session token + identity

The session token and the identity it authenticates.

token

string

required

Session JWT. Send it as Authorization: Bearer <token> on every other call.

principal

string

required

Who the token authenticates — a user email, or the id of the API key it was exchanged for.

project_id

string

required

The Pinecone project the token is scoped to.

project_name

string

required

Human-readable label for the project the token is scoped to.

APIs

Control plane

Data plane

Exchange a Pinecone API key for a session token

Headers

Body

Response