Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to APIpie AI

Scalekit connector
Open markdown

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

Tools
28
What they doRead · write · destructive
17 · 8 · 317 read8 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 APIpie AI connection

    In AgentKit > Connections, create an APIpie AI 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 = 'apipie'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize APIpie AI:', 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: 'apipie_models_detailed_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their APIpie AI 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
  • apipie_models_detailed_listList models with detailed information, optionally filtered by type, provider or name.Read-only

    List Models Detailed

    List models with detailed information, optionally filtered by type, provider or name. Returns models with full metadata, limits, pricing and capabilities. Use apipie_models_list for a quick list.

    Inputs

    modelstring
    Model name. Example: claude-sonnet.
    providerstring
    Model provider. Example: anthropic.
    typestring
    Model type. Example: llm.
  • apipie_models_listList the models available through APIpie, optionally filtered by type, subtype or provider.Read-only

    List Models

    List the models available through APIpie, optionally filtered by type, subtype or provider. Returns models with id, provider, type, subtype, context length and pricing. Use apipie_models_detailed_list for full details.

    Inputs

    combinationstring
    Provider and subtype combination. Example: openai-chat.
    enabledinteger
    1 to show only enabled chat models. Example: 1.one of 10
    providerstring
    Model provider. Example: openai.
    subtypestring
    Model subtype. Example: chat.one of chatfill-maskquestion-answeringttssttmultimodal
    typestring
    Model type. Example: llm.one of llmvisionembeddingimagevoicemoderationcodingfree
  • apipie_property_details_getGet detailed information about one US property by its full address.Read-only

    Get Property Details

    Get detailed information about one US property by its full address. Returns property details such as price or estimate, beds, baths, area, lot, year built, tax and history. Use apipie_real_estate_search to find properties first.

    Inputs

    addressstringrequired
    Full property address. Example: 1600 Pennsylvania Ave NW, Washington, DC 20500.
    userstring
    Your end-user identifier, for per-user usage and billing observability. Example: customer-123.
  • apipie_queries_listList your API query history or its hourly, daily or weekly aggregates, newest first, with filters.Read-only

    List Query History

    List your API query history or its hourly, daily or weekly aggregates, newest first, with filters. Returns query records with timestamp, user, app, provider, route (model), tokens and cost. Use this for cost and usage analysis.

    Inputs

    appstring
    Only this app. Example: supportbot.
    daysinteger
    Days of history. Defaults to 30. Example: 7.
    limitinteger
    Records per page, up to 100. Defaults to 50. Example: 50.
    offsetinteger
    Records to skip. Example: 0.
    providerstring
    Only this provider. Example: openai.
    routestring
    Only this route or model. Example: gpt4omini.
    showstring
    all records, or hourly, daily (default) or weekly aggregates. Example: daily.one of allhourlydailyweekly
    userstring
    Only this user (letters and numbers, up to 14 characters). Example: customer123.
  • apipie_ragtune_collections_listList your RAG tune collections.Read-only

    List RAG Tune Collections

    List your RAG tune collections. Returns the collection names. Use apipie_vector_collections_list for raw vector collections.

    Inputs

    vector_providerstring
    Vector store to use. Use the same provider for a collection every time. Example: qdrant.one of pineconeqdrant