AlphaAlpha
Configures an index by name.
Only the fields present in options are updated; omit a field to leave it unchanged.
The name of the index to configure.
The PreviewConfigureIndexOptions fields to update. Only provided fields are changed.
A promise that resolves to the updated PreviewIndexModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const indexModel = await pc.preview.indexes.configure('my-schema-index', {
deletion_protection: 'enabled',
tags: { team: 'ml-platform' },
});
console.log(indexModel.name);
// 'my-schema-index'
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Creates a schema-based index using the 2026-01.alpha API.
The schema object defines the fields stored in each document. At least one
primary field (dense_vector, sparse_vector, semantic_text, or a string
field with fullTextSearch) must be present.
The PreviewCreateIndexOptions for creating the index, including name, schema, and optional waitUntilReady and timeout.
A promise that resolves to PreviewIndexModel when the creation request is accepted. Use waitUntilReady: true to block until the index is ready for data operations.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const indexModel = await pc.preview.indexes.create({
name: 'my-schema-index',
schema: {
fields: {
chunk_text: { type: 'string', fullTextSearch: {} },
},
},
waitUntilReady: true,
});
console.log(indexModel.name);
// 'my-schema-index'
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeBadRequestError when index creation fails due to invalid parameters or project quotas.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Errors.PineconeConflictError when attempting to create an index using a name that already exists in the project.
Alpha
Creates a backup of an index.
Name of the index to back up.
Optionaloptions: PreviewCreateBackupOptions
Optional PreviewCreateBackupOptions for the backup (name, description).
A promise that resolves to a PreviewBackupModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const backup = await pc.preview.indexes.createBackup('my-schema-index', {
name: 'my-schema-index-backup-1',
description: 'weekly backup',
});
console.log(backup);
// {
// backupId: '11450b9f-96e5-47e5-9186-03f346b1f385',
// sourceIndexName: 'my-schema-index',
// name: 'my-schema-index-backup-1',
// description: 'weekly backup',
// status: 'Initializing',
// cloud: 'aws',
// region: 'us-east-1',
// }
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Creates a collection from a pod-based index.
Collections snapshot the current state of a pod-based index and can be used to create new indexes. Serverless indexes do not support collections.
The PreviewCreateCollectionOptions for the collection, including name and source index name.
A promise that resolves to a PreviewCollectionModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const collection = await pc.preview.indexes.createCollection({
name: 'my-collection',
source: 'my-pod-index',
});
console.log(collection);
// {
// name: 'my-collection',
// status: 'Initializing',
// source: 'my-pod-index'
// }
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Creates an index from a backup. The creation is accepted asynchronously.
Use the returned restoreJobId with describeRestoreJob to poll for completion.
The ID of the backup to restore from.
The PreviewCreateIndexFromBackupOptions for the new index (name required; tags and deletionProtection optional).
A promise that resolves to a PreviewCreateIndexFromBackupResponse containing the restoreJobId and indexId.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const response = await pc.preview.indexes.createFromBackup(
'11450b9f-96e5-47e5-9186-03f346b1f385',
{ name: 'my-schema-index-restored' },
);
console.log(response);
// {
// restoreJobId: '4d4c8693-10fd-4204-a57b-1e3e626fca07',
// indexId: 'deb7688b-9f21-4c16-8eb7-f0027abd27fe'
// }
// Poll until the restore completes
const job = await pc.preview.indexes.describeRestoreJob('4d4c8693-10fd-4204-a57b-1e3e626fca07');
console.log(job.status);
// 'Completed'
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Deletes an index by name.
Deletion is asynchronous; the index may still be terminating after this call returns. Deletion protection must be disabled before calling this method.
The name of the index to delete.
A promise that resolves when the deletion request is accepted.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
await pc.preview.indexes.delete('my-schema-index');
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Deletes a backup. The deletion is accepted asynchronously.
The ID of the backup to delete.
A promise that resolves when the deletion request is accepted.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
await pc.preview.indexes.deleteBackup('11450b9f-96e5-47e5-9186-03f346b1f385');
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Deletes an existing collection by name.
The name of the collection to delete.
A promise that resolves when the deletion request is completed.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
await pc.preview.indexes.deleteCollection('my-collection');
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Describes an index by name, returning its configuration, schema, and status.
The name of the index to describe.
A promise that resolves to PreviewIndexModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const indexModel = await pc.preview.indexes.describe('my-schema-index');
console.log(indexModel);
// {
// name: 'my-schema-index',
// metric: 'cosine',
// host: 'my-schema-index-abc123.svc.pinecone.io',
// schema: {
// fields: { chunk_text: { type: 'string', fullTextSearch: {} } }
// },
// status: { ready: true, state: 'Ready' }
// }
Errors.PineconeArgumentError when arguments passed to the method fail a runtime validation.
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Retrieves the configuration and status of a backup.
The ID of the backup to describe.
A promise that resolves to a PreviewBackupModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const backup = await pc.preview.indexes.describeBackup('11450b9f-96e5-47e5-9186-03f346b1f385');
console.log(backup);
// {
// backupId: '11450b9f-96e5-47e5-9186-03f346b1f385',
// sourceIndexName: 'my-schema-index',
// name: 'my-schema-index-backup-1',
// description: 'weekly backup',
// status: 'Ready',
// cloud: 'aws',
// region: 'us-east-1',
// createdAt: '2025-05-07T03:11:11.722Z'
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Retrieves metadata for a single named collection.
Collections are only supported for pod-based indexes; serverless indexes do not support collections.
The name of the collection to describe.
A promise that resolves to a PreviewCollectionModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const collection = await pc.preview.indexes.describeCollection('my-collection');
console.log(collection);
// {
// name: 'my-collection',
// size: 10000000,
// status: 'Ready',
// dimension: 1536,
// recordCount: 120000,
// source: 'my-pod-index'
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Describes a restore job by ID.
Use this to poll the status of an index restore initiated by createFromBackup.
The restore job ID returned by createFromBackup.
A promise that resolves to a PreviewRestoreJobModel.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const job = await pc.preview.indexes.describeRestoreJob('4d4c8693-10fd-4204-a57b-1e3e626fca07');
console.log(job);
// {
// restoreJobId: '4d4c8693-10fd-4204-a57b-1e3e626fca07',
// backupId: '11450b9f-96e5-47e5-9186-03f346b1f385',
// targetIndexName: 'my-schema-index-restored',
// targetIndexId: 'deb7688b-9f21-4c16-8eb7-f0027abd27fe',
// status: 'Completed',
// percentComplete: 100
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Lists all indexes in the project. The returned list includes schema
fields not present in the stable API's IndexList.
A promise that resolves to PreviewIndexList.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const indexList = await pc.preview.indexes.list();
console.log(indexList);
// {
// indexes: [
// {
// name: 'my-schema-index',
// metric: 'cosine',
// host: 'my-schema-index-abc123.svc.pinecone.io',
// schema: {
// fields: { chunk_text: { type: 'string', fullTextSearch: {} } }
// },
// status: { ready: true, state: 'Ready' }
// }
// ]
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Lists all backups for a specific index.
Name of the index whose backups to list.
Optionaloptions: PreviewListIndexBackupsOptions
Optional PreviewListIndexBackupsOptions pagination parameters (limit, paginationToken).
A promise that resolves to a PreviewBackupList.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const backupList = await pc.preview.indexes.listBackups('my-schema-index', { limit: 10 });
console.log(backupList);
// {
// data: [
// {
// backupId: '11450b9f-96e5-47e5-9186-03f346b1f385',
// sourceIndexName: 'my-schema-index',
// name: 'my-schema-index-backup-1',
// status: 'Ready',
// createdAt: '2025-05-07T03:11:11.722Z'
// }
// ],
// pagination: undefined
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Lists all collections in the current project.
Collections are only supported for pod-based indexes; serverless indexes do not support collections.
A promise that resolves to a PreviewCollectionList.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const collectionList = await pc.preview.indexes.listCollections();
console.log(collectionList);
// {
// collections: [
// {
// name: 'my-collection',
// size: 10000000,
// status: 'Ready',
// dimension: 1536,
// recordCount: 120000,
// source: 'my-pod-index'
// }
// ]
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Lists all backups across every index in the project.
Optionaloptions: PreviewListProjectBackupsOptions
Optional PreviewListProjectBackupsOptions pagination parameters (limit, paginationToken).
A promise that resolves to a PreviewBackupList.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const backupList = await pc.preview.indexes.listProjectBackups({ limit: 5 });
console.log(backupList);
// {
// data: [
// {
// backupId: '11450b9f-96e5-47e5-9186-03f346b1f385',
// sourceIndexName: 'my-schema-index',
// name: 'my-schema-index-backup-1',
// status: 'Ready',
// createdAt: '2025-05-07T03:11:11.722Z'
// }
// ],
// pagination: undefined
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Alpha
Lists all restore jobs for the current project.
Optionaloptions: PreviewListRestoreJobsOptions
Optional PreviewListRestoreJobsOptions pagination parameters (limit, paginationToken).
A promise that resolves to a PreviewRestoreJobList.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const restoreJobs = await pc.preview.indexes.listRestoreJobs({ limit: 3 });
console.log(restoreJobs);
// {
// data: [
// {
// restoreJobId: '4d4c8693-10fd-4204-a57b-1e3e626fca07',
// backupId: '11450b9f-96e5-47e5-9186-03f346b1f385',
// targetIndexName: 'my-schema-index-restored',
// status: 'Completed',
// percentComplete: 100
// }
// ],
// pagination: undefined
// }
Errors.PineconeConnectionError when network problems or an outage of Pinecone's APIs prevent the request from being completed.
Control-plane index operations for Pinecone's alpha API (
2026-01.alpha). Access viapc.preview.indexes.Preview surface is not covered by SemVer — signatures and behavior may change in any minor SDK release. Pin your SDK version when relying on preview features.