docs/ai-agents/connectors/airtable/AUTH.md
This page documents the authentication and configuration options for the Airtable agent connector.
In open source mode, you provide API credentials directly to the connector.
This authentication method isn't available for this connector.
credentials fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
personal_access_token | str | Yes | Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens |
Example request:
from airbyte_agent_airtable import AirtableConnector
from airbyte_agent_airtable.models import AirtableAuthConfig
connector = AirtableConnector(
auth_config=AirtableAuthConfig(
personal_access_token="<Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens>"
)
)
In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the hosted execution tutorial.
This authentication method isn't available for this connector.
This authentication method isn't available for this connector.
Create a connector with Token credentials.
credentials fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
personal_access_token | str | Yes | Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens |
Example request:
curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"customer_name": "<CUSTOMER_NAME>",
"connector_type": "Airtable",
"name": "My Airtable Connector",
"credentials": {
"personal_access_token": "<Airtable Personal Access Token. See https://airtable.com/developers/web/guides/personal-access-tokens>"
}
}'
After creating the connector, execute operations using either the Python SDK or API.
If your Airbyte client can access multiple organizations, include organization_id in AirbyteAuthConfig and X-Organization-Id in raw API calls.
Python SDK
from airbyte_agent_airtable import AirtableConnector, AirbyteAuthConfig
connector = AirtableConnector(
auth_config=AirbyteAuthConfig(
customer_name="<your_customer_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
@agent.tool_plain # assumes you're using Pydantic AI
@AirtableConnector.tool_utils
async def airtable_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
API
curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
-H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
-H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
-H 'Content-Type: application/json' \
-d '{"entity": "<entity>", "action": "<action>", "params": {}}'