Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Pinecone

Scalekit connector
Open markdown

The Pinecone connector lets your AI agent act in each user's Pinecone account. Each user connects their own Pinecone API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 22 tools.

Tools
22
What they doRead · write · destructive
12 · 7 · 312 read7 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Pinecone connection

    In AgentKit > Connections, create a Pinecone connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'pinecone'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Pinecone:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'pinecone_index_stats_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Pinecone credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • pinecone_index_getGet the configuration and status of one Pinecone index by name.Read-only

    Get Index

    Get the configuration and status of one Pinecone index by name. Returns the index host and private host, status (ready, state), deployment, schema (fields with their dimension, metric or embedding model), read capacity, deletion protection and tags. Use this to check that a new index is ready or to read its host. Use pinecone_index_stats_get for record counts per namespace.

    Inputs

    index_namestringrequired
    Name of the Pinecone index to describe, as returned by pinecone_indexes_list. Example: docs-example
  • pinecone_index_stats_getGet record statistics for the Pinecone index on the connected account's index host.Read-only

    Get Index Stats

    Get record statistics for the Pinecone index on the connected account's index host. Returns the total record count, the record count per namespace, the dimension, the index fullness and the metric. Use this to see how much data each namespace holds. Use pinecone_index_get for configuration and pinecone_namespaces_list to page through many namespaces.

    Inputs

    filterobject
    Metadata filter that limits the counted records (pod-based indexes only; serverless indexes reject a filter), written in Pinecone's filter language: a field name maps to a value or to an operator object such as $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin or $exists, and $and / $or combine conditions. Example: {"genre": {"$eq": "documentary"}, "year": {"$gte": 2020}}
  • pinecone_indexes_listList every index in the Pinecone project that the API key belongs to.Read-only

    List Indexes

    List every index in the Pinecone project that the API key belongs to. Returns each index's name, host, status (ready or not), deployment (cloud, region), schema, deletion protection and tags. Use this to find an index name or its data-plane host. Use pinecone_index_get when you already know the index name.

    Inputs

    This tool takes no inputs.

  • pinecone_model_getGet the details of one Pinecone-hosted embedding or reranking model by name.Read-only

    Get Model

    Get the details of one Pinecone-hosted embedding or reranking model by name. Returns its type, vector type, default and supported dimensions, metrics, maximum sequence length and batch size, and supported parameters. Use this to check a model's limits and parameters before calling it. Use pinecone_models_list to see all models.

    Inputs

    model_namestringrequired
    Name of the hosted model. Example: llama-text-embed-v2
  • pinecone_models_listList the embedding and reranking models Pinecone hosts, optionally only one type.Read-only

    List Models

    List the embedding and reranking models Pinecone hosts, optionally only one type. Returns each model's name, type, vector type, supported dimensions and metrics, token limits and parameters. Use this to pick a model for pinecone_embeddings_generate, pinecone_documents_rerank or pinecone_index_create_for_model. Use pinecone_model_get for one model.

    Inputs

    typestring
    Only list models of this type: embed or rerank. Example: embedone of embedrerank
    vector_typestring
    With type embed, only list models that produce this vector type: dense or sparse. Example: denseone of densesparse
  • pinecone_namespace_getGet one namespace of the Pinecone index on the connected account by name.Read-only

    Get Namespace

    Get one namespace of the Pinecone index on the connected account by name. Returns the namespace name, its record count and its schema of indexed metadata fields when one is set. Use this to check how many records a namespace holds. Use pinecone_namespaces_list to find namespace names. Runs against the index host saved on the connected account.

    Inputs

    namespacestringrequired
    Name of the namespace. Use __default__ for the default namespace. Example: example-namespace
  • pinecone_namespaces_listList the namespaces in the Pinecone index on the connected account, optionally only those starting with a prefix.Read-only

    List Namespaces

    List the namespaces in the Pinecone index on the connected account, optionally only those starting with a prefix. Returns each namespace's name and record count, the total count and a pagination token. Use this to find namespace names for the vector and record tools. Use pinecone_namespace_get for one namespace. Runs against the index host saved on the connected account.

    Inputs

    limitinteger
    Maximum number of namespaces to return, from 1 to 100. Defaults to 100. Example: 50
    pagination_tokenstring
    Token for the next page of namespaces, taken from pagination.next in the previous response. Leave empty for the first page. Example: Tm90aGluZyB0byBzZWUgaGVyZQo=
    prefixstring
    Only return namespaces whose name starts with this text. Example: customer-