Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Typefully

Scalekit connector
Open markdown

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

Tools
18
What they doRead · write · destructive
10 · 7 · 110 read7 write1 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 Typefully connection

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

    Each user opens the link once and enters their Typefully 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
  • typefully_get_draftGet one draft with its full content.Read-only

    Get Draft

    Get one draft with its full content. Returns the draft's status, publish_state, title, tags, scheduled date, share and private URLs, the per-platform posts and any published post URLs. Use it to read a draft before editing it, or to poll publish_state after publishing with publish_at set to now. Use list_drafts to find draft ids.

    Inputs

    draft_idintegerrequired
    Numeric ID of the draft. Get it from typefully_list_drafts or from the response of typefully_create_draft.
    social_set_idintegerrequired
    Numeric ID of the Typefully social set (connected account profile) to act on. Get it from typefully_list_social_sets.
  • typefully_get_meGet the Typefully user that owns the API key.Read-only

    Get Current User

    Get the Typefully user that owns the API key. Returns the user id, name, email, profile image URL, signup date and the label of the API key. Use it to confirm the credential works. Use list_social_sets to find the accounts this user can post to.

    Inputs

    This tool takes no inputs.

  • typefully_get_queueGet the publishing queue of a social set for a date range, with the scheduled drafts and open slots for each day.Read-only

    Get Queue

    Get the publishing queue of a social set for a date range, with the scheduled drafts and open slots for each day. Returns start_date, end_date and a days list describing each day's slots and scheduled drafts. Use it to see what is scheduled and which slots are free. Use list_drafts with status scheduled for a flat list of drafts.

    Inputs

    end_datestringrequired
    Last day of the range as a date in YYYY-MM-DD format.
    social_set_idintegerrequired
    Numeric ID of the Typefully social set (connected account profile) to act on. Get it from typefully_list_social_sets.
    start_datestringrequired
    First day of the range as a date in YYYY-MM-DD format.
  • typefully_get_queue_scheduleGet the recurring posting schedule of a social set's queue.Read-only

    Get Queue Schedule

    Get the recurring posting schedule of a social set's queue. Returns the social set id, its timezone and the list of rules, each with hour, minute and days of the week. Use it to see when next-free-slot publishing lands. Use update_queue_schedule to change it.

    Inputs

    social_set_idintegerrequired
    Numeric ID of the Typefully social set (connected account profile) to act on. Get it from typefully_list_social_sets.
  • typefully_get_social_setGet the details of one social set (connected account profile).Read-only

    Get Social Set

    Get the details of one social set (connected account profile). Returns its id, username, name, team, connected platforms and publishing quota. Use it to see which platforms are connected before creating a draft. Use list_social_sets to find the id.

    Inputs

    social_set_idintegerrequired
    Numeric ID of the Typefully social set (connected account profile) to act on. Get it from typefully_list_social_sets.
  • typefully_list_comment_threadsList the comment threads on a draft.Read-only

    List Comment Threads

    List the comment threads on a draft. Returns a page of threads with id, platform, status, the selected text each is anchored to and its comments, plus paging fields. Use it to read review feedback on a draft. Use create_comment_thread to start a new thread.

    Inputs

    draft_idintegerrequired
    Numeric ID of the draft. Get it from typefully_list_drafts or from the response of typefully_create_draft.
    social_set_idintegerrequired
    Numeric ID of the Typefully social set (connected account profile) to act on. Get it from typefully_list_social_sets.
    limitinteger
    Maximum number of items to return per page, from 1 to 50. The API default is 10.
    offsetinteger
    Number of items to skip before returning results, for paging through long lists. The API default is 0.
    platformstring
    Only return threads on this platform's posts. Leave empty for all platforms.one of xlinkedinmastodonthreadsblueskysubstackx_article
    statusstring
    Which threads to return: unresolved, resolved or all. The API default is unresolved, so resolved threads are left out unless you ask for them.one of unresolvedresolvedall
  • typefully_list_draftsList drafts in a social set, optionally filtered by status or tag.Read-only

    List Drafts

    List drafts in a social set, optionally filtered by status or tag. Returns a page of drafts with id, status, preview text, scheduled date, tags, private URL and per-platform published timestamps, plus paging fields. Use it to browse or find drafts. Use get_draft for the full content of one draft.

    Inputs

    social_set_idintegerrequired
    Numeric ID of the Typefully social set (connected account profile) to act on. Get it from typefully_list_social_sets.
    limitinteger
    Maximum number of items to return per page, from 1 to 50. The API default is 10.
    offsetinteger
    Number of items to skip before returning results, for paging through long lists. The API default is 0.
    order_bystring
    Field to sort by. Prefix with a minus sign for descending order. The API default is -updated_at (most recently edited first).one of created_at-created_atupdated_at-updated_atscheduled_date-scheduled_datepublished_at-published_at
    statusstring
    Only return drafts with this status. 'draft' is saved but unscheduled, 'scheduled' will auto-publish at its scheduled date, 'planned' has a date but will not publish until confirmed, 'publishing' is in flight, 'published' was posted and 'error' failed to publish. Leave empty for all statuses.one of draftpublishedscheduledplannederrorpublishing
    tagstring
    Only return drafts that have this tag. Use the tag slug (not its display name) from typefully_list_tags, for example product-launch.
  • typefully_list_social_setsList the social sets (connected account profiles) the API key can access.Read-only

    List Social Sets

    List the social sets (connected account profiles) the API key can access. Returns a page of social sets with id, username, name and connected platforms, plus count and next/previous links. Use it first to get the social_set_id that every draft, tag and queue tool needs. Use get_social_set for one set's details.

    Inputs

    limitinteger
    Maximum number of items to return per page, from 1 to 50. The API default is 10.
    offsetinteger
    Number of items to skip before returning results, for paging through long lists. The API default is 0.