# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
index_model = pc.indexes.describe(name="articles")
print(index_model.status, index_model.schema)
host = index_model.host
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
const indexModel = await pc.indexes.describe('articles');
console.log(indexModel.status, indexModel.schema);
const host = indexModel.host;
package main
import (
"context"
"encoding/json"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
idx, err := pc.DescribeIndex(ctx, "articles")
if err != nil {
log.Fatalf("Failed to describe index: %v", err)
}
schema, err := json.Marshal(idx.Schema)
if err != nil {
log.Fatalf("Failed to marshal schema: %v", err)
}
fmt.Println(idx.Status.State, string(schema))
host := idx.Host
fmt.Println(host)
}
# Requires Terraform provider v5.0.0 or later
data "pinecone_index" "articles" {
name = "articles"
}
output "articles_host" {
value = data.pinecone_index.articles.host
}
output "articles_status" {
value = data.pinecone_index.articles.status
}
output "articles_schema" {
value = data.pinecone_index.articles.schema
}
PINECONE_API_KEY="YOUR_API_KEY"
curl "https://api.pinecone.io/indexes/articles" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2026-07"
{
"deletion_protection": "disabled",
"deployment": {
"cloud": "aws",
"deployment_type": "managed",
"region": "us-east-1"
},
"host": "movie-recommendations-c01b5b5.svc.us-east1-gcp.pinecone.io",
"name": "movie-recommendations",
"read_capacity": {
"mode": "OnDemand",
"status": {
"state": "Ready"
}
},
"schema": {
"fields": {
"your_vector": {
"dimension": 1536,
"metric": "cosine",
"type": "dense_vector"
}
}
},
"status": {
"ready": true,
"state": "Ready"
}
}Describe an index
Get a description of an index.
# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
index_model = pc.indexes.describe(name="articles")
print(index_model.status, index_model.schema)
host = index_model.host
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
const indexModel = await pc.indexes.describe('articles');
console.log(indexModel.status, indexModel.schema);
const host = indexModel.host;
package main
import (
"context"
"encoding/json"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
idx, err := pc.DescribeIndex(ctx, "articles")
if err != nil {
log.Fatalf("Failed to describe index: %v", err)
}
schema, err := json.Marshal(idx.Schema)
if err != nil {
log.Fatalf("Failed to marshal schema: %v", err)
}
fmt.Println(idx.Status.State, string(schema))
host := idx.Host
fmt.Println(host)
}
# Requires Terraform provider v5.0.0 or later
data "pinecone_index" "articles" {
name = "articles"
}
output "articles_host" {
value = data.pinecone_index.articles.host
}
output "articles_status" {
value = data.pinecone_index.articles.status
}
output "articles_schema" {
value = data.pinecone_index.articles.schema
}
PINECONE_API_KEY="YOUR_API_KEY"
curl "https://api.pinecone.io/indexes/articles" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2026-07"
{
"deletion_protection": "disabled",
"deployment": {
"cloud": "aws",
"deployment_type": "managed",
"region": "us-east-1"
},
"host": "movie-recommendations-c01b5b5.svc.us-east1-gcp.pinecone.io",
"name": "movie-recommendations",
"read_capacity": {
"mode": "OnDemand",
"status": {
"state": "Ready"
}
},
"schema": {
"fields": {
"your_vector": {
"dimension": 1536,
"metric": "cosine",
"type": "dense_vector"
}
}
},
"status": {
"ready": true,
"state": "Ready"
}
}status.ready: true (and, for Dedicated read capacity, read_capacity.status.state: "Ready") before performing data plane operations.
# pip install --upgrade pinecone
import os
from pinecone import Pinecone
pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])
index_model = pc.indexes.describe(name="articles")
print(index_model.status, index_model.schema)
host = index_model.host
// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';
// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();
const indexModel = await pc.indexes.describe('articles');
console.log(indexModel.status, indexModel.schema);
const host = indexModel.host;
package main
import (
"context"
"encoding/json"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v7/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: os.Getenv("PINECONE_API_KEY"),
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
idx, err := pc.DescribeIndex(ctx, "articles")
if err != nil {
log.Fatalf("Failed to describe index: %v", err)
}
schema, err := json.Marshal(idx.Schema)
if err != nil {
log.Fatalf("Failed to marshal schema: %v", err)
}
fmt.Println(idx.Status.State, string(schema))
host := idx.Host
fmt.Println(host)
}
# Requires Terraform provider v5.0.0 or later
data "pinecone_index" "articles" {
name = "articles"
}
output "articles_host" {
value = data.pinecone_index.articles.host
}
output "articles_status" {
value = data.pinecone_index.articles.status
}
output "articles_schema" {
value = data.pinecone_index.articles.schema
}
PINECONE_API_KEY="YOUR_API_KEY"
curl "https://api.pinecone.io/indexes/articles" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2026-07"
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Response
Configuration information and deployment status of the index.
The IndexModel describes the configuration and status of a Pinecone index.
The deployment configuration of a Pinecone index. The deployment_type field indicates which infrastructure model the index uses.
pod: Dedicated pod-based infrastructure. Suitable for workloads that require predictable performance.managed: Serverless infrastructure managed by Pinecone, including full-text search indexes. Scales automatically; billed per usage.byoc: Bring-your-own-compute. Runs in customer-managed infrastructure.
- Pod-based
- Serverless
- BYOC
Show child attributes
Show child attributes
{
"deployment_type": "pod",
"environment": "us-east1-gcp",
"pod_type": "p1.x1",
"replicas": 1,
"shards": 1
}
The schema of a Pinecone index. The schema defines the typed fields that documents in the index can contain, including vector fields, string fields searched by full-text search or by embeddings, and metadata fields.
Show child attributes
Show child attributes
{
"fields": {
"body": {
"embed": {
"dimension": 1024,
"metric": "cosine",
"model": "llama-text-embed-v2"
},
"full_text_search": {
"language": "en",
"stemming": false,
"stop_words": false
},
"sparse_embed": { "model": "pinecone-sparse-english-v0" },
"store_text": true,
"type": "string"
},
"title": {
"full_text_search": {
"language": "en",
"stemming": false,
"stop_words": false
},
"store_text": true,
"type": "string"
}
}
}
Whether deletion protection is enabled/disabled for the index.
Possible values: disabled or enabled.
Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '_', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags.
Show child attributes
Show child attributes
{ "tag0": "val0", "tag1": "val1" }
Was this page helpful?