AgentKit API reference

This page as markdown Whole reference as one file

AgentKit's API lets your agent act in each user's apps. It sends the user to approve access, keeps their tokens, and runs tools as that user.

The API is REST over HTTPS. Requests and responses are JSON, and every request carries a bearer token. Call it with the Python or Node.js SDK, or from any language over HTTP. Each endpoint page shows the REST request and the SDK methods that call it.

A connector is the app, such as Gmail, and a connection is your configuration for it, so the REST field connector takes the connection name, such as my-gmail.

Start here

Authenticate with your client ID and secret.
Create a user's authorization link and send them to approve.
Execute a tool as that user.

For a working agent end to end, follow the Quickstart. To use AgentKit with LangChain, Google ADK, the Vercel AI SDK or another framework, choose a framework.

Resources

Base URL

https://<your-environment>.scalekit.dev
https://<your-environment>.scalekit.com

Development environments end in .scalekit.dev, Production in .scalekit.com. Copy yours from Developers > Settings > API Credentials. See Environments and regions.

SDKs

Python
Node.js

pip install scalekit-sdk-python

npm install @scalekit-sdk/node

Source and releases: scalekit-sdk-python, scalekit-sdk-node.

Create a client

TOKEN=$(curl -sS "$SCALEKIT_ENVIRONMENT_URL/oauth/token" \
  -d grant_type=client_credentials \
  -d client_id="$SCALEKIT_CLIENT_ID" \
  -d client_secret="$SCALEKIT_CLIENT_SECRET" | jq -r .access_token)

import os
from scalekit import ScalekitClient

scalekit_client = ScalekitClient(
    env_url=os.environ["SCALEKIT_ENVIRONMENT_URL"],
    client_id=os.environ["SCALEKIT_CLIENT_ID"],
    client_secret=os.environ["SCALEKIT_CLIENT_SECRET"],
)
actions = scalekit_client.actions

import { ScalekitClient } from '@scalekit-sdk/node';

const scalekit = new ScalekitClient(
  process.env.SCALEKIT_ENVIRONMENT_URL!,
  process.env.SCALEKIT_CLIENT_ID!,
  process.env.SCALEKIT_CLIENT_SECRET!,
);
const actions = scalekit.actions;