Quickstart

Connect your own GitHub account and make your first tool call as that user. New Scalekit environments include a GitHub connection, so there’s nothing to set up in GitHub. About 10 minutes.

Using a coding agent?Copy AgentKit prompt

• A Scalekit account at app.scalekit.com
• Python 3.10+, Node.js 18.14+, or curl and jq
• Your environment URL, client ID and client secret. Open Developers > Settings > API Credentials: copy the Environment URL and Client ID from Environment details, then select Generate new secret under Client secrets. The secret is shown once, so copy it right away. See API credentials.
• The GitHub connection name from AgentKit > Connections. New environments call it github-connect.

1. Install the SDK

   Section titled “Install the SDK”
   • Python
   • Node.js

   pip install scalekit-sdk-python python-dotenv

2. Add your credentials

   Section titled “Add your credentials”

   Create a .env file next to your script. Don’t commit it.

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<client-id>
   SCALEKIT_CLIENT_SECRET=<client-secret>
   GITHUB_CONNECTION_NAME=github-connect

3. Write the script

   Section titled “Write the script”

   Save this as agent.py, agent.ts or agent.sh. It connects the user if needed, then calls GitHub as them.

   • Python
   • Node.js
   • cURL

   1
   import os
   2
   
   3
   from dotenv import load_dotenv
   4
   from scalekit import ScalekitClient
   5
   
   6
   load_dotenv()
   7
   
   8
   scalekit_client = ScalekitClient(
   9
       env_url=os.environ["SCALEKIT_ENVIRONMENT_URL"],
   10
       client_id=os.environ["SCALEKIT_CLIENT_ID"],
   11
       client_secret=os.environ["SCALEKIT_CLIENT_SECRET"],
   12
   )
   13
   actions = scalekit_client.actions
   14
   
   15
   connection_name = os.environ["GITHUB_CONNECTION_NAME"]
   16
   user_id = "user_123"  # your app's ID for this user: stable and hard to guess
   17
   
   18
   # Find this user's connected account, or create it on the first run
   19
   account = actions.get_or_create_connected_account(
   20
       connection_name=connection_name,
   21
       identifier=user_id,
   22
   ).connected_account
   23
   
   24
   if account.status != "ACTIVE":
   25
       link = actions.get_authorization_link(
   26
           connection_name=connection_name,
   27
           identifier=user_id,
   28
       ).link
   29
       print(f"Open this link and approve access:\n{link}")
   30
       input("Press Enter when you're done...")
   31
   
   32
       account = actions.get_connected_account(
   33
           connection_name=connection_name,
   34
           identifier=user_id,
   35
       ).connected_account
   36
       if account.status != "ACTIVE":
   37
           raise SystemExit(f"The account is {account.status}, not ACTIVE. Run the script again.")
   38
   
   39
   # Call GitHub as this user. The tool is read-only.
   40
   result = actions.execute_tool(
   41
       tool_name="github_user_get_authenticated",
   42
       tool_input={},
   43
       connected_account_id=account.id,
   44
   )
   45
   print(result.data)

   user_123 stands in for your app’s user ID. Choose an identifier explains what to use in production.

4. Run it

   Section titled “Run it”
   • Python
   • Node.js
   • cURL

   python agent.py

   The first run prints a link. Open it, approve access on GitHub, then press Enter. You’ll see your GitHub profile. Run it again: the account is already ACTIVE, so the script skips the link.

GITHUB_CONNECTION_NAME doesn’t match the dashboard exactly. Copy it again from AgentKit > Connections.

The approval wasn’t finished, or the link expired. Links last five minutes by default. Run the script again for a fresh link.

User verification is set to Custom user verifier, so the link request needs a verify URL. For this quickstart, use None or Scalekit users only in AgentKit > Settings > User Verification. To set up the custom user verifier, see Verify users.

The .env file wasn’t loaded. Run the script from the folder that contains it.

The client ID or secret is wrong, or the secret was regenerated.

Before real users connect accounts, verify users.

API reference

The endpoints this page's code calls, with every field and the SDK method for each:

• POSTCreate a connected account
• GETGet a connected account's credentials
• POSTGet an authorization link
• POSTExecute a tool