Pinecone integration guide
VerifiedHow to connect Pinecone to WEXTL and use its 77 actions in your workflows. About Pinecone: Vector database and assistant platform for AI search.
- 37 searches
- 40 actions
- Polling
- Auth: API key
AI-assisted documentation20 min read
This documentation is compiled from our integration source code, internal specs for Pinecone, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Pinecone credentials
- API KeypasswordRequired
In the console open API keys and create a key for your project. Copy it now. A key works for one project.[1]
Connect Pinecone in WEXTL
- Log in to your WEXTL account, add the Pinecone node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Pinecone account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Pinecone triggers and actions on WEXTL
The list below is a reference of every Pinecone node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Pinecone node module below to see exactly what it takes in, what it returns, and what connection it needs.
Fetch Documents
SearchDocument retrieval from a namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
LimitRequired | number |
| Document IDs | array |
| ID | text |
| Filter | text |
| Include Fields | array |
| Field | text |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
Fetch Vectors
SearchVector lookup by ID list.
| Field | Type |
|---|---|
IndexRequired | choice |
Vector IDsRequired | array |
| ID | text |
| Namespace | choice |
| Field | Type |
|---|---|
| ID | text |
| Values | array |
| Values Item | number |
| Metadata | object |
| Genre | text |
Fetch Vectors by Metadata
SearchVector lookup driven by a metadata query.
| Field | Type |
|---|---|
IndexRequired | choice |
FilterRequired | text |
LimitRequired | number |
| Namespace | choice |
| Field | Type |
|---|---|
| ID | text |
| Values | array |
| Values Item | number |
| Metadata | object |
| Genre | text |
Get a Backup
SearchDetails of one stored backup.
| Field | Type |
|---|---|
BackupRequired | choice |
| Field | Type |
|---|---|
| Backup ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Name | text |
| Description | text |
| Status | text |
| Cloud | text |
| Region | text |
| Record Count | number |
| Namespace Count | number |
| Size Bytes | number |
| Tags | object |
| Environment | text |
| Created At | text |
Get a Backup Schedule
SearchPlan behind recurring backups.
| Field | Type |
|---|---|
IndexRequired | choice |
ScheduleRequired | choice |
| Field | Type |
|---|---|
| Schedule ID | text |
| Name | text |
| Index ID | text |
| Project ID | text |
| Schedule Type | text |
| Frequency | text |
| Retention Expire After Days | number |
| Enabled | boolean |
| Next Scheduled Run | text |
| Created At | text |
Get a Bulk Import
SearchProgress meter of a record import.
| Field | Type |
|---|---|
IndexRequired | choice |
ImportRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Uri | text |
| Status | text |
| Created At | text |
| Percent Complete | number |
| Records Imported | number |
Get a Conversion Job
SearchState of an index conversion.
| Field | Type |
|---|---|
Conversion JobRequired | choice |
| Field | Type |
|---|---|
| Conversion Job ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Target Index Name | text |
| Target Index ID | text |
| Status | text |
| Percent Complete | number |
| Records Converted | number |
| Records Skipped | number |
| Created At | text |
Get a Model
SearchFacts about one inference model.
| Field | Type |
|---|---|
ModelRequired | choice |
| Field | Type |
|---|---|
| Model | text |
| Short Description | text |
| Type | text |
| Vector Type | text |
| Default Dimension | number |
| Modality | text |
| Max Sequence Length | number |
| Max Batch Size | number |
| Provider Name | text |
| Supported Dimensions | array |
| Supported Dimensions Item | number |
| Supported Metrics | array |
| Supported Metrics Item | text |
| Supported On | array |
| Supported On Item | text |
| Supported Parameters | array |
| Supported Parameters Item | object |
Get a Namespace
SearchRow count and storage of a namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Record Count | text |
| Indexed Fields | object |
| Fields | array |
| Size Bytes | text |
Get a Namespace Alias
SearchWhere an alias points to now.
| Field | Type |
|---|---|
IndexRequired | choice |
AliasRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Target Namespace | text |
| Created At | text |
| Updated At | text |
Get a Restore Job
SearchProgress of an index restore.
| Field | Type |
|---|---|
Restore JobRequired | choice |
| Field | Type |
|---|---|
| Restore Job ID | text |
| Backup ID | text |
| Target Index Name | text |
| Target Index ID | text |
| Status | text |
| Created At | text |
| Completed At | text |
| Percent Complete | number |
Get an Assistant
SearchInstructions and host of an assistant.
| Field | Type |
|---|---|
AssistantRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Instructions | text |
| Metadata | object |
| Team | text |
| Status | text |
| Host | text |
| Region | text |
| Created At | text |
| Updated At | text |
Get an Assistant File
SearchDetails of an assistant upload.
| Field | Type |
|---|---|
AssistantRequired | choice |
FileRequired | choice |
| Include Download URL | boolean |
| Field | Type |
|---|---|
| Name | text |
| ID | text |
| Size | number |
| Metadata | object |
| Type | text |
| Created On | text |
| Updated On | text |
| Status | text |
| Signed URL | text |
| Multimodal | boolean |
Get an Assistant Operation
SearchProgress of an assistant task.
| Field | Type |
|---|---|
AssistantRequired | choice |
OperationRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Operation Type | text |
| File ID | text |
| Status | text |
| Created On | text |
| Percent Complete | number |
Get an Index
SearchHost and schema of one index.
| Field | Type |
|---|---|
IndexRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Host | text |
| Status | object |
| Ready | boolean |
| State | text |
| Deployment | object |
| Deployment Type | text |
| Cloud | text |
| Region | text |
| Schema | object |
| Fields | object |
| Tags | object |
| Environment | text |
| Deletion Protection | text |
Get Index Stats
SearchSize and fullness of an index.
| Field | Type |
|---|---|
IndexRequired | choice |
| Filter | text |
| Field | Type |
|---|---|
| Namespaces | array |
| Namespaces Item | object |
| Dimension | number |
| Total Vector Count | number |
| Metric | text |
| Vector Type | text |
| Index Fullness | number |
List Assistant Files
SearchDocuments an assistant can read.
| Field | Type |
|---|---|
AssistantRequired | choice |
LimitRequired | number |
| Metadata Filter | text |
| Field | Type |
|---|---|
| Name | text |
| ID | text |
| Size | number |
| Metadata | object |
| Type | text |
| Created On | text |
| Updated On | text |
| Status | text |
| Signed URL | text |
| Multimodal | boolean |
List Assistant Operations
SearchTask history of an assistant.
| Field | Type |
|---|---|
AssistantRequired | choice |
LimitRequired | number |
| Operation Type | choice |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Operation Type | text |
| File ID | text |
| Status | text |
| Created On | text |
| Percent Complete | number |
List Assistants
SearchAssistants in your Pinecone account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Name | text |
| Instructions | text |
| Metadata | object |
| Team | text |
| Status | text |
| Host | text |
| Region | text |
| Created At | text |
| Updated At | text |
List Backup Schedule History
SearchBackups made by one recurring plan.
| Field | Type |
|---|---|
IndexRequired | choice |
ScheduleRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Backup ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Name | text |
| Description | text |
| Status | text |
| Cloud | text |
| Region | text |
| Record Count | number |
| Namespace Count | number |
| Size Bytes | number |
| Tags | object |
| Environment | text |
| Created At | text |
List Backup Schedules
SearchBackup plans on one index.
| Field | Type |
|---|---|
IndexRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Schedule ID | text |
| Name | text |
| Index ID | text |
| Project ID | text |
| Schedule Type | text |
| Frequency | text |
| Retention Expire After Days | number |
| Enabled | boolean |
| Next Scheduled Run | text |
| Created At | text |
List Backups
SearchStored copies of an index.
| Field | Type |
|---|---|
IndexRequired | choice |
LimitRequired | number |
| Include Deleted | boolean |
| Field | Type |
|---|---|
| Backup ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Name | text |
| Description | text |
| Status | text |
| Cloud | text |
| Region | text |
| Record Count | number |
| Namespace Count | number |
| Size Bytes | number |
| Tags | object |
| Environment | text |
| Created At | text |
List Bulk Imports
SearchImport history for an index.
| Field | Type |
|---|---|
IndexRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Uri | text |
| Status | text |
| Created At | text |
| Percent Complete | number |
| Records Imported | number |
List Conversion Jobs
SearchIndex conversion jobs and their status.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Conversion Job ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Target Index Name | text |
| Target Index ID | text |
| Status | text |
| Percent Complete | number |
| Records Converted | number |
| Records Skipped | number |
| Created At | text |
List Documents
SearchDocument IDs of a namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
LimitRequired | number |
| Prefix | text |
| Field | Type |
|---|---|
| ID | text |
List Indexes
SearchEvery index in your project.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Name | text |
| Host | text |
| Status | object |
| Ready | boolean |
| State | text |
| Deployment | object |
| Deployment Type | text |
| Cloud | text |
| Region | text |
| Schema | object |
| Fields | object |
| Tags | object |
| Environment | text |
| Deletion Protection | text |
List Models
SearchEmbedding and rerank models offered.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Vector Type | choice |
| Field | Type |
|---|---|
| Model | text |
| Short Description | text |
| Type | text |
| Vector Type | text |
| Default Dimension | number |
| Modality | text |
| Max Sequence Length | number |
| Max Batch Size | number |
| Provider Name | text |
| Supported Dimensions | array |
| Supported Dimensions Item | number |
| Supported Metrics | array |
| Supported Metrics Item | text |
| Supported On | array |
| Supported On Item | text |
List Namespace Aliases
SearchAlias names set on an index.
| Field | Type |
|---|---|
IndexRequired | choice |
LimitRequired | number |
| Prefix | text |
| Target Namespace | choice |
| Field | Type |
|---|---|
| Name | text |
| Target Namespace | text |
| Created At | text |
| Updated At | text |
List Namespaces
SearchPartitions of an index.
| Field | Type |
|---|---|
IndexRequired | choice |
LimitRequired | number |
| Prefix | text |
| Field | Type |
|---|---|
| Name | text |
| Record Count | text |
| Indexed Fields | object |
| Fields | array |
| Size Bytes | text |
List Project Backups
SearchBackups across all indexes.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Backup ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Name | text |
| Description | text |
| Status | text |
| Cloud | text |
| Region | text |
| Record Count | number |
| Namespace Count | number |
| Size Bytes | number |
| Tags | object |
| Environment | text |
| Created At | text |
List Restore Jobs
SearchPast and running restore operations.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Restore Job ID | text |
| Backup ID | text |
| Target Index Name | text |
| Target Index ID | text |
| Status | text |
| Created At | text |
| Completed At | text |
| Percent Complete | number |
List Vector IDs
SearchIdentifiers of stored vectors.
| Field | Type |
|---|---|
IndexRequired | choice |
LimitRequired | number |
| Namespace | choice |
| Prefix | text |
| Field | Type |
|---|---|
| ID | text |
Retrieve the Assistant Context
SearchSnippets found in assistant files.
| Field | Type |
|---|---|
AssistantRequired | choice |
| Query | text |
| Messages | array |
| Message | object |
| Top K | number |
| Snippet Size | number |
| Filter | text |
| Multimodal | boolean |
| Include Binary Content | boolean |
| Field | Type |
|---|---|
| Type | text |
| Content | text |
| Score | number |
| Reference | object |
| Type | text |
| File | object |
| Pages | array |
Search Documents
SearchScored documents from a namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
Score ByRequired | text |
Top KRequired | number |
| Include Fields | array |
| Field | text |
| Filter | text |
| Field | Type |
|---|---|
| ID | text |
| Score | number |
| Title | text |
Search Similar Vectors by ID
SearchNearest neighbors of a stored vector.
| Field | Type |
|---|---|
IndexRequired | choice |
Vector IDRequired | text |
Top KRequired | number |
| Namespace | choice |
| Filter | text |
| Include Values | boolean |
| Include Metadata | boolean |
| Field | Type |
|---|---|
| ID | text |
| Score | number |
| Values | array |
| Values Item | number |
| Sparse Values | object |
| Indices | array |
| Values | array |
| Metadata | object |
| Genre | text |
Search Text Records
SearchText search over stored records.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
Query TextRequired | text |
Top KRequired | number |
| Filter | text |
| Fields | array |
| Field | text |
| Rerank Model | text |
| Rank Fields | array |
| Field | text |
| Rerank Top N | number |
| Field | Type |
|---|---|
| ID | text |
| Score | number |
| Fields | object |
| Chunk Text | text |
Search Vectors
SearchNearest neighbors of a query vector.
| Field | Type |
|---|---|
IndexRequired | choice |
Query VectorRequired | array |
| Value | number |
Top KRequired | number |
| Namespace | choice |
| Filter | text |
| Include Values | boolean |
| Include Metadata | boolean |
| Sparse Indices | array |
| Index | number |
| Sparse Values | array |
| Value | number |
| Field | Type |
|---|---|
| ID | text |
| Score | number |
| Values | array |
| Values Item | number |
| Sparse Values | object |
| Indices | array |
| Values | array |
| Metadata | object |
| Genre | text |
Cancel a Bulk Import
ActionHalts an in-progress import.
| Field | Type |
|---|---|
IndexRequired | choice |
ImportRequired | choice |
| Field | Type |
|---|---|
| Cancelled | boolean |
| ID | text |
Cancel a Conversion Job
ActionHalts an index conversion.
| Field | Type |
|---|---|
Conversion JobRequired | choice |
| Field | Type |
|---|---|
| Conversion Job ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Target Index Name | text |
| Target Index ID | text |
| Status | text |
| Percent Complete | number |
| Records Converted | number |
| Records Skipped | number |
| Created At | text |
Chat with an Assistant
ActionAnswer from an assistant with citations.
| Field | Type |
|---|---|
AssistantRequired | choice |
| Message | text |
| Messages | array |
| Message | object |
| Model | choice |
| Temperature | number |
| Filter | text |
| Include Highlights | boolean |
| JSON Response | boolean |
| Top K | number |
| Snippet Size | number |
| Field | Type |
|---|---|
| ID | text |
| Finish Reason | text |
| Message | object |
| Role | text |
| Content | text |
| Model | text |
| Citations | array |
| Citations Item | object |
| Usage | object |
| Prompt Tokens | number |
| Completion Tokens | number |
| Total Tokens | number |
Convert an Index
ActionMigrates an index to a new schema.
| Field | Type |
|---|---|
IndexRequired | choice |
New Index NameRequired | text |
FieldsRequired | array |
| Field | object |
| On Error | choice |
| Deletion Protection | boolean |
| Tags | array |
| Tag | object |
| Field | Type |
|---|---|
| Conversion Job ID | text |
| Index ID | text |
Create a Backup
ActionSnapshot of an index.
| Field | Type |
|---|---|
IndexRequired | choice |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| Backup ID | text |
| Source Index Name | text |
| Source Index ID | text |
| Name | text |
| Description | text |
| Status | text |
| Cloud | text |
| Region | text |
| Record Count | number |
| Namespace Count | number |
| Size Bytes | number |
| Tags | object |
| Environment | text |
| Created At | text |
Create a Backup Schedule
ActionRecurring backups for an index.
| Field | Type |
|---|---|
IndexRequired | choice |
NameRequired | text |
FrequencyRequired | choice |
Keep For DaysRequired | number |
| Field | Type |
|---|---|
| Schedule ID | text |
| Name | text |
| Index ID | text |
| Project ID | text |
| Schedule Type | text |
| Frequency | text |
| Retention Expire After Days | number |
| Enabled | boolean |
| Next Scheduled Run | text |
| Created At | text |
Create a Bulk Import
ActionStarts importing records from cloud storage.
| Field | Type |
|---|---|
IndexRequired | choice |
Storage URIRequired | text |
| Integration ID | text |
| On Error | choice |
| Field | Type |
|---|---|
| ID | text |
Create a Namespace
ActionNew partition inside an index.
| Field | Type |
|---|---|
IndexRequired | choice |
NameRequired | text |
| Schema | text |
| Field | Type |
|---|---|
| Name | text |
| Record Count | text |
| Indexed Fields | object |
| Fields | array |
| Size Bytes | text |
Create a Namespace Alias
ActionStable name for a namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
Alias NameRequired | text |
Target NamespaceRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Target Namespace | text |
| Created At | text |
| Updated At | text |
Create a Vector Index
ActionNew index for dense or sparse vectors.
| Field | Type |
|---|---|
NameRequired | text |
Vector TypeRequired | choice |
CloudRequired | choice |
RegionRequired | text |
| Deletion Protection | boolean |
| Tags | array |
| Tag | object |
| Field | Type |
|---|---|
| Name | text |
| Host | text |
| Status | object |
| Ready | boolean |
| State | text |
| Deployment | object |
| Deployment Type | text |
| Cloud | text |
| Region | text |
| Schema | object |
| Fields | object |
| Tags | object |
| Environment | text |
| Deletion Protection | text |
Create an Assistant
ActionNew assistant with custom instructions.
| Field | Type |
|---|---|
NameRequired | text |
| Instructions | text |
| Region | choice |
| Metadata | text |
| Field | Type |
|---|---|
| Name | text |
| Instructions | text |
| Metadata | object |
| Team | text |
| Status | text |
| Host | text |
| Region | text |
| Created At | text |
| Updated At | text |
Create an Index
ActionNew index with a field schema.
| Field | Type |
|---|---|
CloudRequired | choice |
RegionRequired | text |
FieldsRequired | array |
| Field | object |
| Name | text |
| Deletion Protection | boolean |
| Tags | array |
| Tag | object |
| Field | Type |
|---|---|
| Name | text |
| Host | text |
| Status | object |
| Ready | boolean |
| State | text |
| Deployment | object |
| Deployment Type | text |
| Cloud | text |
| Region | text |
| Schema | object |
| Fields | object |
| Tags | object |
| Environment | text |
| Deletion Protection | text |
Create an Index from a Backup
ActionRestores backup data into a new index.
| Field | Type |
|---|---|
BackupRequired | choice |
New Index NameRequired | text |
| Deletion Protection | boolean |
| Tags | array |
| Tag | object |
| Field | Type |
|---|---|
| Restore Job ID | text |
| Index ID | text |
Delete a Backup
ActionOne stored backup gone from the index.
| Field | Type |
|---|---|
BackupRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Backup ID | text |
Delete a Backup Schedule
ActionRecurring backup plan removed from an index.
| Field | Type |
|---|---|
IndexRequired | choice |
ScheduleRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Schedule ID | text |
Delete a Namespace
ActionNamespace deletion with its data.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Namespace | text |
Delete a Namespace Alias
ActionNamespace alias taken out of an index.
| Field | Type |
|---|---|
IndexRequired | choice |
AliasRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Alias | text |
Delete All Documents
ActionNamespace clear-out behind a confirm switch.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
ConfirmRequired | boolean |
| Field | Type |
|---|---|
| Deleted | boolean |
| Namespace | text |
Delete All Vectors in a Namespace
ActionNamespace emptying behind a confirm switch.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
ConfirmRequired | boolean |
| Field | Type |
|---|---|
| Deleted | boolean |
| Namespace | text |
Delete an Assistant
ActionAssistant gone from your Pinecone account.
| Field | Type |
|---|---|
AssistantRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Name | text |
Delete an Assistant File
ActionUploaded file dropped from an assistant.
| Field | Type |
|---|---|
AssistantRequired | choice |
FileRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| File ID | text |
Delete an Index
ActionWhole index removed from your project.
| Field | Type |
|---|---|
IndexRequired | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Name | text |
Delete Documents
ActionDocument deletion by ID or filter.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
| Document IDs | array |
| ID | text |
| Filter | text |
| Field | Type |
|---|---|
| Deleted | boolean |
| Matched Records | number |
Delete Vectors
ActionVector deletion by ID list.
| Field | Type |
|---|---|
IndexRequired | choice |
Vector IDsRequired | array |
| ID | text |
| Namespace | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
| Count | number |
Delete Vectors by Metadata
ActionVector deletion driven by a metadata query.
| Field | Type |
|---|---|
IndexRequired | choice |
FilterRequired | text |
| Namespace | choice |
| Field | Type |
|---|---|
| Deleted | boolean |
Generate Embeddings
ActionVectors made from text.
| Field | Type |
|---|---|
ModelRequired | choice |
TextsRequired | array |
| Text | text |
| Input Type | choice |
| Truncate | choice |
| Field | Type |
|---|---|
| Model | text |
| Vector Type | text |
| Vectors | array |
| Vectors Item | array |
| Embeddings | array |
| Embeddings Item | object |
| Total Tokens | number |
Make an API Call
universalCustom Pinecone REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Target | choice |
| Index | choice |
| Assistant | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Repoint a Namespace Alias
ActionRedirects an alias to another namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
AliasRequired | choice |
Target NamespaceRequired | choice |
| Field | Type |
|---|---|
| Name | text |
| Target Namespace | text |
| Created At | text |
| Updated At | text |
Rerank Documents
ActionRelevance ranking of texts.
| Field | Type |
|---|---|
ModelRequired | choice |
QueryRequired | text |
TextsRequired | array |
| Text | text |
| Top N | number |
| Return Documents | boolean |
| Field | Type |
|---|---|
| Model | text |
| Results | array |
| Results Item | object |
| Rerank Units | number |
Update a Backup Schedule
ActionEdits a backup plan.
| Field | Type |
|---|---|
IndexRequired | choice |
ScheduleRequired | choice |
| Frequency | choice |
| Keep For Days | number |
| Enabled | choice |
| Field | Type |
|---|---|
| Schedule ID | text |
| Name | text |
| Index ID | text |
| Project ID | text |
| Schedule Type | text |
| Frequency | text |
| Retention Expire After Days | number |
| Enabled | boolean |
| Next Scheduled Run | text |
| Created At | text |
Update a Vector
ActionEdits one stored vector.
| Field | Type |
|---|---|
IndexRequired | choice |
Vector IDRequired | text |
| Namespace | choice |
| Values | array |
| Value | number |
| Sparse Indices | array |
| Index | number |
| Sparse Values | array |
| Value | number |
| Metadata to Set | text |
| Field | Type |
|---|---|
| Updated | boolean |
| ID | text |
Update an Assistant
ActionEdits assistant instructions and metadata.
| Field | Type |
|---|---|
AssistantRequired | choice |
| Instructions | text |
| Metadata | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Assistant Name | text |
| Instructions | text |
| Metadata | object |
| Team | text |
Update an Index
ActionEdits index protection and tags.
| Field | Type |
|---|---|
IndexRequired | choice |
| Deletion Protection | choice |
| Tags to Set | array |
| Tag | object |
| Remove Tags | array |
| Tag Key | text |
| Field | Type |
|---|---|
| Name | text |
| Host | text |
| Status | object |
| Ready | boolean |
| State | text |
| Deployment | object |
| Deployment Type | text |
| Cloud | text |
| Region | text |
| Schema | object |
| Fields | object |
| Tags | object |
| Environment | text |
| Deletion Protection | text |
Update Documents
ActionEdits existing documents in a namespace.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
| Documents | array |
| Document | object |
| Filter | text |
| Fields to Set | text |
| Fields to Remove | array |
| Field | text |
| Field | Type |
|---|---|
| Matched Records | number |
| Usage | object |
| Embed Total Tokens | number |
Update Vectors by Metadata
ActionBulk metadata edit driven by a filter.
| Field | Type |
|---|---|
IndexRequired | choice |
FilterRequired | text |
Metadata to SetRequired | text |
| Namespace | choice |
| Dry Run | boolean |
| Field | Type |
|---|---|
| Matched Records | number |
Upload a File to an Assistant
ActionAdds knowledge to an assistant.
| Field | Type |
|---|---|
AssistantRequired | choice |
FileRequired | text |
| File Name | text |
| Metadata | text |
| Multimodal | boolean |
| Field | Type |
|---|---|
| ID | text |
| Operation Type | text |
| File ID | text |
| Status | text |
| Created On | text |
| Percent Complete | number |
Upsert an Assistant File
ActionAdds or replaces an assistant file.
| Field | Type |
|---|---|
AssistantRequired | choice |
File IDRequired | choice |
FileRequired | text |
| File Name | text |
| Metadata | text |
| Multimodal | boolean |
| Field | Type |
|---|---|
| ID | text |
| Operation Type | text |
| File ID | text |
| Status | text |
| Created On | text |
| Percent Complete | number |
Upsert Documents
ActionInserts or overwrites documents.
| Field | Type |
|---|---|
IndexRequired | choice |
NamespaceRequired | choice |
DocumentsRequired | array |
| Document | object |
| Field | Type |
|---|---|
| Upserted Count | number |
| Usage | object |
| Embed Total Tokens | number |
Templates
Look for Pinecone templates in the WEXTL template library.
Browse templates →Other database integrations on WEXTL
Ninox[2]Low-code database and workflow platform.
BubbleCreate, search, update and delete records in the database of a Bubble app.
QdrantManage Qdrant collections and points, run vector search and scroll queries, and handle snapshots and cluster operations.
MilvusOpen-source vector database for storing and searching embedding data at scale.
KnackNo-code database platform for custom tables, records, file uploads, and live-app views.
References
- WEXTL® Pinecone Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Pinecone.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.

























