The Bika AI connector lets your AI agent act in each user's Bika AI account. Each user connects their own Bika AI access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 35 tools.
- Tools
- 35
- What they doRead · write · destructive
- 18 · 9 · 818 read9 write8 destructive
- Users sign in with
- Access token
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 Bika AI connection
In AgentKit > Connections, create a Bika AI 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 = 'bika'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Bika AI:', 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: 'bika_spaces_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 = "bika"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Bika AI:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="bika_spaces_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Bika AI credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbika_automation_triggers_listList the triggers of an automation.Read-onlyList Automation Triggers
List the triggers of an automation. Returns success, code, message and data with the automation's triggers. Use bika_nodes_list to find automation IDs.
Inputs
automation_idstringrequired- ID of the automation (starts with ato), from bika_nodes_list. Example: atoA1b2C3d4E5.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_database_fields_listList a database's fields (columns).Read-onlyList Database Fields
List a database's fields (columns). Returns success, code, message and data with the database's fields. Use field names or ids as keys in bika_records_create and bika_record_update.
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_database_getGet a database's definition.Read-onlyGet Database
Get a database's definition. Returns success, code, message and data with the database definition. Use bika_database_fields_list for field types before writing records.
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_database_views_listList a database's views.Read-onlyList Database Views
List a database's views. Returns success, code, message and data with the database's views. Use this to understand how the database is organized.
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_embed_links_listList the embed links created in a space.Read-onlyList Embed Links
List the embed links created in a space. Returns success, code, message and data with each link's id, objectType, objectId and url. Use bika_embed_link_create to share a node in an iframe.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_member_getGet one member of a space.Read-onlyGet Member
Get one member of a space. Returns success, code, message and data with the member's details. Use bika_team_members_list to find member IDs.
Inputs
member_idstringrequired- ID of the space member. Example: mebA1b2C3d4.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_node_getGet one node resource in a space.Read-onlyGet Node Resource
Get one node resource in a space. Returns success, code, message and data with the node resource. Use bika_database_get for database details.
Inputs
node_idstringrequired- ID of the node resource, from bika_nodes_list. Example: datJubyEnetNFd3UQ6gSeq7U.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_nodes_listList the node resources in a space: databases, automations, dashboards, documents, folders and AI agents.Read-onlyList Node Resources
List the node resources in a space: databases, automations, dashboards, documents, folders and AI agents. Returns success, code, message and data with the space's node resources (id, name and type). Use node IDs with bika_node_get; a database's node ID is its database ID.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_outgoing_webhooks_listList a space's outgoing webhooks.Read-onlyList Outgoing Webhooks
List a space's outgoing webhooks. Returns success, code, message and data with the space's outgoing webhooks. Use bika_outgoing_webhook_delete to remove one.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_record_getGet one record from a database.Read-onlyGet Record
Get one record from a database. Returns success, code, message and data with the record's id, fields, createdAt and updatedAt. Use bika_records_list to find record IDs.
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
record_idstringrequired- ID of the record (starts with rec). Example: recAbC123dEf456GhI789.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
cell_formatstring- json (default) returns typed values; string returns display text and needs time_zone and user_locale. Example: json.one of
jsonstring field_keystring- Key fields by name (default) or by field id. Example: name.one of
nameid time_zonestring- Time zone for dates with cell_format string. Example: America/New_York.
user_localestring- Locale for dates with cell_format string. Example: en.one of
enzh-CNzh-TWjaptde
bika_records_listList records in a database, with optional filter, field selection and paging.Read-onlyList Records
List records in a database, with optional filter, field selection and paging. Returns success, code, message and data with records (each id, fields, createdAt and updatedAt), hasMore and offset for the next page. Use filter for matching records. Use bika_record_get for one record.
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
cell_formatstring- json (default) returns typed values; string returns display text and needs time_zone and user_locale. Example: json.one of
jsonstring field_keystring- Key fields by name (default) or by field id. Example: name.one of
nameid fieldsarray- Only return these fields. Example: ["Name", "Status"]
filterstring- Filter in Bika's filter query language, for example field1=="value1";field2>10 (see https://bika.ai/help/guide/developer/filter-query-language). Example: Status=="Open";Priority>2.
max_recordsinteger- Maximum total records to return. Example: 300.
offsetstring- offset from the previous response, to get the next page. Example: itrA1b2C3d4.
page_sizeinteger- Records per page. Default 100. Example: 100.
time_zonestring- Time zone for dates with cell_format string. Example: America/New_York.
user_localestring- Locale for dates with cell_format string. Example: en.one of
enzh-CNzh-TWjaptde
bika_roles_listList the roles in a space.Read-onlyList Roles
List the roles in a space. Returns success, code, message and data with pageNo, pageSize, total and roles (id, name, manageSpace, permissions, memberCount). Use role IDs with bika_member_update.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
directionstring- Sort direction. Example: asc.one of
ascdesc namestring- Only roles whose name matches. Example: Editors.
page_nointeger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
sortstring- Field to sort by. Example: name.
bika_space_getGet one space.Read-onlyGet Space
Get one space. Returns success, code, message and data with the space's id, name, slug, logo, createBy, createdAt and settings. Use bika_nodes_list to see what it contains.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_spaces_listList the Bika.ai spaces (workspaces) the user belongs to.Read-onlyList Spaces
List the Bika.ai spaces (workspaces) the user belongs to. Returns success, code, message and data with each space's id, name, slug, logo, createBy and createdAt. Use this first: almost every other Bika tool needs a space ID.
Inputs
This tool takes no inputs.
bika_system_meta_getGet Bika.ai system metadata for the API.Read-onlyGet System Info
Get Bika.ai system metadata for the API. Returns success, code, message and data with version, hostname and build details. Use this to check that the connection works.
Inputs
This tool takes no inputs.
bika_team_members_listList the members of a team.Read-onlyList Team Members
List the members of a team. Returns success, code, message and data with pageNo, pageSize, total and members (id, name, userId, email, nickName, isGuest, isSpaceOwner). Use member IDs with bika_member_get or bika_member_update.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
team_idstringrequired- ID of the team, from bika_teams_list. Example: teamX1y2Z3.
page_nointeger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
bika_teams_listList teams in a space, at the root or under a parent team.Read-onlyList Teams
List teams in a space, at the root or under a parent team. Returns success, code, message and data with pageNo, pageSize, total and teams (id, name, parentId, memberCount, path). Use bika_team_members_list for a team's members.
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
page_nointeger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page. Example: 50.
parent_team_idstring- List sub-teams of this team. Leave empty for the root's sub-teams. Example: teamX1y2Z3.
bika_user_profile_getGet the profile of the user who owns the API token.Read-onlyGet User Profile
Get the profile of the user who owns the API token. Returns success, code, message and data with the user's profile. Use this to confirm which account the connection acts as.
Inputs
This tool takes no inputs.
bika_embed_link_createCreate an embed link for a node resource so it can be shown in another site.WriteCreate Embed Link
Create an embed link for a node resource so it can be shown in another site. Returns success, code, message and data with the new link's id, objectType, objectId and url. Use bika_embed_link_delete to revoke it.
Inputs
object_idstringrequired- ID of the node resource to embed. Example: datJubyEnetNFd3UQ6gSeq7U.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_member_updateChange a member's display name, teams or roles.WriteUpdate Member
Change a member's display name, teams or roles. Returns success, code, message and data with the updated member. team_ids and role_ids replace the member's current lists.
- Idempotent
Inputs
member_idstringrequired- ID of the space member. Example: mebA1b2C3d4.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
namestring- New display name in the space. Example: Jane Doe.
role_idsarray- IDs of the member's roles. Example: ["roleA1b2C3"]
team_idsarray- IDs of the teams the member belongs to. Example: ["teamX1y2Z3"]
bika_record_updateUpdate one record's fields.WriteUpdate Record
Update one record's fields. Returns success, code, message and data with the updated record. Only the fields you send change.
- Idempotent
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
fieldsobjectrequired- Fields to change, keyed by field name (or id with field_key id). Example: {"Status": "Closed"}
record_idstringrequired- ID of the record (starts with rec). Example: recAbC123dEf456GhI789.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
field_keystring- Whether the field keys you send are field names (default) or field ids. Example: name.one of
nameid
bika_records_createCreate one or more records in a database.WriteCreate Records
Create one or more records in a database. Returns success, code, message and data with the created records (id, fields, createdAt, updatedAt). Each record is {"fields": {...}} keyed by field name (or id with field_key id). Use bika_database_fields_list for field names and types.
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
recordsarrayrequired- Records to create, each an object with a fields object. Example: [{"fields": {"Name": "New lead", "Status": "Open"}}]
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
field_keystring- Whether the field keys you send are field names (default) or field ids. Example: name.one of
nameid
bika_records_updateUpdate up to 10 records at once.WriteUpdate Records
Update up to 10 records at once. Returns success, code, message and data with the updated records. Each record needs its id and the fields to change. Use bika_record_update for one record.
- Idempotent
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
recordsarrayrequired- Up to 10 records, each with id and a fields object. Example: [{"id": "recAbC123dEf456GhI789", "fields": {"Status": "Closed"}}]
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
field_keystring- Whether the field keys you send are field names (default) or field ids. Example: name.one of
nameid
bika_role_createCreate a role with admin permissions in a space.WriteCreate Role
Create a role with admin permissions in a space. Returns success, code, message and data with the new role. Assign it with bika_member_update.
Inputs
namestringrequired- Role name. Example: Workspace managers.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
manage_spaceboolean- Give the role full space management rights. Default false. Example: false.
permissionsarray- Admin areas the role can manage. Example: ["member", "team"]
bika_role_updateChange a role's name or permissions.WriteUpdate Role
Change a role's name or permissions. Returns success, code, message and data with the updated role. permissions replaces the current list.
- Idempotent
Inputs
role_idstringrequired- ID of the role, from bika_roles_list. Example: roleA1b2C3.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
manage_spaceboolean- Give the role full space management rights. Example: false.
namestring- New role name. Example: Team managers.
permissionsarray- Admin areas the role can manage. Example: ["member", "team", "role"]
bika_team_createCreate a team in a space.WriteCreate Team
Create a team in a space. Returns success, code, message and data with the new team. Use an empty parent_team_id for a top-level team.
Inputs
namestringrequired- Team name. Example: Sales.
parent_team_idstringrequired- ID of the parent team; an empty string creates a top-level team. Example: teamX1y2Z3.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_team_updateRename a team.WriteRename Team
Rename a team. Returns success, code, message and data with the updated team. Use bika_teams_list to find team IDs.
- Idempotent
Inputs
namestringrequired- New team name. Example: Sales EMEA.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
team_idstringrequired- ID of the team, from bika_teams_list. Example: teamX1y2Z3.
bika_automation_run_cancelCancel an automation run that is waiting on a delay step.DestructiveCancel Delayed Automation Run
Cancel an automation run that is waiting on a delay step. Returns success, code, message and data with true when it was cancelled. Use the run ID from the automation's run history.
Inputs
run_idstringrequired- ID of the automation run. Example: runA1b2C3d4E5.
bika_embed_link_deleteDelete (revoke) an embed link.DestructiveDelete Embed Link
Delete (revoke) an embed link. Returns success, code, message and data. Pages embedding it stop working.
- Idempotent
Inputs
embed_link_idstringrequired- ID of the embed link, from bika_embed_links_list. Example: embA1b2C3d4.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_member_deleteRemove a member from a space.DestructiveRemove Member
Remove a member from a space. Returns success, code, message and data. They lose access to the space's resources.
- Idempotent
Inputs
member_idstringrequired- ID of the space member. Example: mebA1b2C3d4.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_outgoing_webhook_deleteDelete an outgoing webhook from a space.DestructiveDelete Outgoing Webhook
Delete an outgoing webhook from a space. Returns success, code, message and data. Use bika_outgoing_webhooks_list to find IDs.
- Idempotent
Inputs
outgoing_webhook_idstringrequired- ID of the outgoing webhook. Example: owhA1b2C3d4.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_record_deleteDelete one record.DestructiveDelete Record
Delete one record. Returns success, code, message and data. Use bika_records_delete for several records.
- Idempotent
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
record_idstringrequired- ID of the record (starts with rec). Example: recAbC123dEf456GhI789.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_records_deleteDelete up to 10 records at once.DestructiveDelete Records
Delete up to 10 records at once. Returns success, code, message and data with each record's id and deleted flag. Use bika_record_delete for one record.
- Idempotent
Inputs
database_idstringrequired- ID of the database (starts with dat; same as its node ID), from bika_nodes_list or the database URL. Example: datJubyEnetNFd3UQ6gSeq7U.
recordsarrayrequired- IDs of the records to delete, at most 10. Example: ["recAbC123dEf456GhI789"]
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_role_deleteDelete a role.DestructiveDelete Role
Delete a role. Returns success, code, message and data. Members with the role lose its permissions.
- Idempotent
Inputs
role_idstringrequired- ID of the role, from bika_roles_list. Example: roleA1b2C3.
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
bika_team_deleteDelete a team.DestructiveDelete Team
Delete a team. Returns success, code, message and data. Members stay in the space.
- Idempotent
Inputs
space_idstringrequired- ID of the space (starts with spc), from bika_spaces_list or the space URL. Example: spcND68gdMMZBmGK67gvqNVX.
team_idstringrequired- ID of the team, from bika_teams_list. Example: teamX1y2Z3.
No tools match.