> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ByteForms

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

**Authentication:** API Key
**Categories:** Productivity
**Tools:** 3: 3 read, 0 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BYTEFORMS)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ByteForms connection

   In **AgentKit > Connections**, create a ByteForms connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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 = 'byteforms'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize ByteForms:', 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: 'byteforms_forms_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

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

   connection_name = "byteforms"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize ByteForms:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="byteforms_forms_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ByteForms credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'byteforms_form_get',
  toolInput: {
    form_id: '<form_id>',
  },
  connector: 'byteforms',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="byteforms_form_get",
    tool_input={
        "form_id": "<form_id>",
    },
    connection_name="byteforms",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `byteforms_form_get`

Get Form · Read-only

Get one ByteForms form by its ID.
Returns data (the form with id, public_id, name, its fields with labels, types and validation, and settings) and status.
Use this to read a form's fields before reading its responses. Use byteforms_forms_list to find the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `form_id` (`string`, required): ID of the ByteForms form, the id field from byteforms_forms_list. Example: 1.

Example input: `{"form_id":"<form_id>"}`

### `byteforms_form_responses_list`

List Form Responses · Read-only

List the responses submitted to a ByteForms form, with search, ordering and cursor paging.
Returns count, cursor (after and before), data (the responses with their answers and submission time) and status.
Use this to read submissions. Pass cursor.after from the last page as after to get the next page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `form_id` (`string`, required): ID of the ByteForms form, the id field from byteforms_forms_list. Example: 1.
- `after` (`string`, optional): Cursor from the previous page's cursor.after, to get the next page. Example: eyJpZCI6MTIzfQ.
- `before` (`string`, optional): Cursor from the previous page's cursor.before, to get the page before. Example: eyJpZCI6MTAwfQ.
- `limit` (`integer`, optional): Maximum number of responses to return. Example: 50.
- `order` (`string`, optional): Sort order by submission time: asc or desc. Example: desc. One of: `asc`, `desc`.
- `query` (`string`, optional): Text to search the responses for. Example: jane@example.com.

Example input: `{"form_id":"<form_id>"}`

### `byteforms_forms_list`

List Forms · Read-only

List all the forms in your ByteForms account.
Returns data (an array of forms with id, public_id, name, the form body of fields, and settings) and status.
Use this to find a form ID. Use byteforms_form_get for one form.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

## Related

Other Productivity connectors ([all 203](/agentkit/connectors/?category=productivity)):

- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Workspace (DWD)](/agentkit/connectors/googledwd/): Scalekit connector, Service account, 100 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
