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.
- Tools
- 3
- What they doRead · write · destructive
- 3 · 0 · 03 read0 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the ByteForms connection
In AgentKit > Connections, create a ByteForms connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'byteforms'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'byteforms_forms_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "byteforms"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="byteforms_forms_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ByteForms credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbyteforms_form_getGet one ByteForms form by its ID.Read-onlyGet Form
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.
Inputs
form_idstringrequired- ID of the ByteForms form, the id field from byteforms_forms_list. Example: 1.
byteforms_form_responses_listList the responses submitted to a ByteForms form, with search, ordering and cursor paging.Read-onlyList Form Responses
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.
Inputs
form_idstringrequired- ID of the ByteForms form, the id field from byteforms_forms_list. Example: 1.
afterstring- Cursor from the previous page's cursor.after, to get the next page. Example: eyJpZCI6MTIzfQ.
beforestring- Cursor from the previous page's cursor.before, to get the page before. Example: eyJpZCI6MTAwfQ.
limitinteger- Maximum number of responses to return. Example: 50.
orderstring- Sort order by submission time: asc or desc. Example: desc.one of
ascdesc querystring- Text to search the responses for. Example: jane@example.com.
byteforms_forms_listList all the forms in your ByteForms account.Read-onlyList Forms
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.
Inputs
This tool takes no inputs.
No tools match.