Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Countdown API

Scalekit connector
Open markdown

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

Tools
30
What they doRead · write · destructive
11 · 15 · 411 read15 write4 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 Countdown API connection

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

    Each user opens the link once and enters their Countdown API 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
  • countdown_account_getGet Countdown API account usage and platform status.Read-only

    Get Account

    Get Countdown API account usage and platform status. Free: it uses no credits. Returns account_info (plan, credits used and remaining this month, overage) and platform status. Use it to check the API key and remaining credits.

    Inputs

    This tool takes no inputs.

  • countdown_collection_getGet one Countdown API collection.Read-only

    Get Collection

    Get one Countdown API collection. Returns the collection: name, status (idle, queued, running), schedule, priority, notification settings, requests_count, requests_page_count and last run. Check status before adding or updating requests; they can only change while the collection is not running.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.
  • countdown_collection_requests_exportGet a download link for all requests in a Countdown API collection as JSON or CSV.Read-only

    Export Collection Requests

    Get a download link for all requests in a Countdown API collection as JSON or CSV. Returns request_info and a download link for the file. Use countdown_collection_requests_list to read requests page by page instead.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.
    formatstringrequired
    File format: json or csv.one of jsoncsv
  • countdown_collection_requests_findFind requests in a Countdown API collection by text in their parameters or by custom_id.Read-only

    Find Collection Requests

    Find requests in a Countdown API collection by text in their parameters or by custom_id. Returns matching requests[] (id, custom_id, type and parameters). Use countdown_collection_request_update or countdown_collection_request_delete on a match.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.
    custom_idstring
    Find the request with this custom_id. Example: MyCustomID_001.
    pageinteger
    Page of matches, starting at 1. Example: 1.default 1
    qstring
    Text to search for in the request parameters. Example: memory cards.
  • countdown_collection_requests_listList the requests in a Countdown API collection, 1,000 per page.Read-only

    List Collection Requests

    List the requests in a Countdown API collection, 1,000 per page. Returns requests[] (id, custom_id, type and its parameters) for the page. Use countdown_collection_requests_find to search by text or custom_id.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.
    pageinteger
    Page of requests, starting at 1 (see requests_page_count from countdown_collection_get). Example: 1.default 1
  • countdown_collection_result_exportGet a single-file download link for a Countdown API result set in JSON Lines or CSV format.Read-only

    Export Result Set

    Get a single-file download link for a Countdown API result set in JSON Lines or CSV format. Returns result details and the download link for the file. Use countdown_collection_result_get for paged JSON links.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.
    formatstringrequired
    File format: jsonlines or csv.one of jsonlinescsv
    result_set_idstringrequired
    ID of the result set. Example: 1.
  • countdown_collection_result_getGet one result set of a Countdown API collection with JSON download links for its result pages.Read-only

    Get Result Set

    Get one result set of a Countdown API collection with JSON download links for its result pages. Returns result (id, run times, request and credit counts) and download_links for each page of JSON results. Use countdown_collection_results_list to find the result set ID; use countdown_collection_result_export for one JSON Lines or CSV file.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.
    result_set_idstringrequired
    ID of the result set. Example: 1.
  • countdown_collection_results_listList the result sets of a Countdown API collection (kept for 14 days).Read-only

    List Result Sets

    List the result sets of a Countdown API collection (kept for 14 days). Returns results[] (id, started_at, ended_at, requests_completed, credits_used) for each run. Use countdown_collection_result_get for the download links of one result set.

    Inputs

    collection_idstringrequired
    ID of the collection. Find it with countdown_collections_list. Example: 123456.