Airtable

Learn how to use Airtable with Composio

Overview

SLUG: AIRTABLE

Description

Airtable merges spreadsheet functionality with database power, enabling teams to organize projects, track tasks, and collaborate through customizable views, automation, and integrations for data management

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to data.records:read,data.records:write,data.recordComments:read,data.recordComments:write,schema.bases:read,schema.bases:write,user.email:read
bearer_token
string
token
stringRequired
generic_api_key
stringRequired

Connecting to Airtable

Create an auth config

Use the dashboard to create an auth config for the Airtable toolkit. This allows you to connect multiple Airtable accounts to Composio for agents to use.

1

Select App

Navigate to the Airtable toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5airtable_auth_config_id = "ac_YOUR_AIRTABLE_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/application
7
8composio = Composio()
9
10
11def authenticate_toolkit(user_id: str, auth_config_id: str):
12 connection_request = composio.connected_accounts.initiate(
13 user_id=user_id,
14 auth_config_id=auth_config_id,
15 )
16
17 print(
18 f"Visit this URL to authenticate Airtable: {connection_request.redirect_url}"
19 )
20
21 # This will wait for the auth flow to be completed
22 connection_request.wait_for_connection(timeout=15)
23 return connection_request.id
24
25
26connection_id = authenticate_toolkit(user_id, airtable_auth_config_id)
27
28# You can also verify the connection status using:
29connected_account = composio.connected_accounts.get(connection_id)
30print(f"Connected account: {connected_account}")

Using Bearer Token

1from composio import Composio
2from composio.types import auth_scheme
3
4# Auth config ID created above
5airtable_auth_config_id = "ac_YOUR_AIRTABLE_CONFIG_ID"
6
7# UUID from database/application
8user_id = "0000-0000-0000"
9
10composio = Composio()
11
12
13def authenticate_toolkit(user_id: str, auth_config_id: str):
14 # Replace this with a method to retrieve the Bearer Token from the user.
15 bearer_token = input("[!] Enter bearer token")
16 connection_request = composio.connected_accounts.initiate(
17 user_id=user_id,
18 auth_config_id=auth_config_id,
19 config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
20 )
21 print(f"Successfully connected Airtable for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, airtable_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5airtable_auth_config_id = "ac_YOUR_AIRTABLE_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 # Replace this with a method to retrieve an API key from the user.
12 # Or supply your own.
13 user_api_key = input("[!] Enter API key")
14
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "API_KEY", "val": user_api_key}
19 )
20
21 # API Key authentication is immediate - no redirect needed
22 print(f"Successfully connected Airtable for user {user_id}")
23 print(f"Connection status: {connection_request.status}")
24
25 return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, airtable_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Airtable toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["AIRTABLE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: List bases

Description

Retrieves all airtable bases accessible to the authenticated user, which may include an 'offset' for pagination.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create base

Description

Creates a new airtable base with specified tables and fields within a workspace; ensure field options are valid for their type.

Action Parameters

name
stringRequired
tables
arrayRequired
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Comment

Description

Creates a new comment on a specific record within an airtable base and table.

Action Parameters

baseId
stringRequired
recordId
stringRequired
tableIdOrName
stringRequired
text
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Field

Description

Creates a new field within a specified table in an airtable base.

Action Parameters

baseId
stringRequired
description
string
name
stringRequired
options
object
tableId
stringRequired
type
stringDefaults to singleLineText

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create multiple records

Description

Creates multiple new records in a specified airtable table.

Action Parameters

baseId
stringRequired
records
arrayRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a record

Description

Creates a new record in a specified airtable table; field values must conform to the table's column types.

Action Parameters

baseId
stringRequired
fields
objectRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create table

Description

Creates a new table within a specified existing airtable base, allowing definition of its name, description, and field structure.

Action Parameters

baseId
stringRequired
description
string
fields
arrayRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Comment

Description

Deletes an existing comment from a specified record in an airtable table.

Action Parameters

baseId
stringRequired
recordId
stringRequired
rowCommentId
stringRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete multiple records

Description

Deletes up to 10 specified records from a table within an airtable base.

Action Parameters

baseId
stringRequired
recordIds
arrayRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Record

Description

Permanently deletes a specific record from an existing table within an existing airtable base.

Action Parameters

baseId
stringRequired
recordId
stringRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Base Schema

Description

Retrieves the detailed schema for a specified airtable base, including its tables, fields, field types, and configurations, using the `baseid`.

Action Parameters

baseId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Record

Description

Retrieves a specific record from a table within an airtable base.

Action Parameters

baseId
stringRequired
cellFormat
stringDefaults to json
recordId
stringRequired
returnFieldsByFieldId
boolean
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get user information

Description

Retrieves information, such as id and permission scopes, for the currently authenticated airtable user from the `/meta/whoami` endpoint.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Comments

Description

Retrieves all comments for a specific record in an airtable table, requiring existing `baseid`, `tableidorname`, and `recordid`.

Action Parameters

baseId
stringRequired
recordId
stringRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List records

Description

Retrieves records from an airtable table, with options for filtering, sorting, pagination, and specifying returned fields.

Action Parameters

baseId
stringRequired
cellFormat
stringDefaults to json
fields
array
filterByFormula
string
maxRecords
integer
offset
string
pageSize
integerDefaults to 100
recordMetadata
array
returnFieldsByFieldId
boolean
sort
array
tableIdOrName
stringRequired
timeZone
stringDefaults to utc
userLocale
string
view
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update multiple records

Description

Updates multiple existing records in a specified airtable table; these updates are not performed atomically.

Action Parameters

baseId
stringRequired
records
arrayRequired
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update record

Description

Modifies specified fields of an existing record in an airtable base and table; the base, table, and record must exist.

Action Parameters

baseId
stringRequired
fields
objectRequired
recordId
stringRequired
returnFieldsByFieldId
boolean
tableIdOrName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired