Amplitude authentication
This page documents the authentication and configuration options for the Amplitude agent connector.
Authentication
Open source execution
In open source mode, you provide API credentials directly to the connector.
OAuth
This authentication method isn't available for this connector.
Token
credentials fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
api_key | str | Yes | Your Amplitude project API key. Find it in Settings > Projects in your Amplitude account. |
secret_key | str | Yes | Your Amplitude project secret key. Find it in Settings > Projects in your Amplitude account. |
Example request:
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
from airbyte_agent_sdk.connectors.amplitude.models import AmplitudeAuthConfig
connector = AmplitudeConnector(
auth_config=AmplitudeAuthConfig(
api_key="<Your Amplitude project API key. Find it in Settings > Projects in your Amplitude account.
>",
secret_key="<Your Amplitude project secret key. Find it in Settings > Projects in your Amplitude account.
>"
)
)
Hosted execution
In hosted mode, you first create a connector via the Airbyte Agent 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 developer quickstart.
OAuth
This authentication method isn't available for this connector.
Bring your own OAuth flow
This authentication method isn't available for this connector.
Token
Create a connector with Token credentials.
credentials fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
api_key | str | Yes | Your Amplitude project API key. Find it in Settings > Projects in your Amplitude account. |
secret_key | str | Yes | Your Amplitude project secret key. Find it in Settings > Projects in your Amplitude account. |
replication_config fields you need:
| Field Name | Type | Required | Description |
|---|---|---|---|
start_date | str (date-time) | Yes | UTC date and time in the format YYYY-MM-DDTHH:mm:ssZ. Any data before this date will not be replicated. |
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 '{
"workspace_name": "<WORKSPACE_NAME>",
"connector_type": "Amplitude",
"name": "My Amplitude Connector",
"credentials": {
"api_key": "<Your Amplitude project API key. Find it in Settings > Projects in your Amplitude account.
>",
"secret_key": "<Your Amplitude project secret key. Find it in Settings > Projects in your Amplitude account.
>"
},
"replication_config": {
"start_date": "<UTC date and time in the format YYYY-MM-DDTHH:mm:ssZ. Any data before this date will not be replicated.
>"
}
}'
Execution
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
The connect() factory returns a fully typed AmplitudeConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:
- Pydantic AI
- LangChain
- OpenAI Agents
- FastMCP
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
connector = connect("amplitude", workspace_name="<your_workspace_name>")
agent = Agent("openai:gpt-4o")
@agent.tool_plain
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
from langchain_core.tools import tool
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
connector = connect("amplitude", workspace_name="<your_workspace_name>")
@tool
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
"""Execute Amplitude connector operations."""
result = await connector.execute(entity, action, params or {})
# connector.execute returns a Pydantic envelope for typed actions; fall back to raw data otherwise.
return result.model_dump(mode="json") if hasattr(result, "model_dump") else result
from agents import Agent, function_tool
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
connector = connect("amplitude", workspace_name="<your_workspace_name>")
# strict_mode=False because `params: dict` is permissive and the default strict
# JSON schema rejects objects with additionalProperties.
@function_tool(strict_mode=False)
@AmplitudeConnector.tool_utils(framework="openai_agents")
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
"""Execute Amplitude connector operations."""
result = await connector.execute(entity, action, params or {})
return result.model_dump(mode="json") if hasattr(result, "model_dump") else result
agent = Agent(name="Amplitude Assistant", tools=[amplitude_execute])
from fastmcp import FastMCP
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
connector = connect("amplitude", workspace_name="<your_workspace_name>")
mcp = FastMCP("Amplitude Agent")
@mcp.tool
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
"""Execute Amplitude connector operations."""
result = await connector.execute(entity, action, params or {})
return result.model_dump(mode="json") if hasattr(result, "model_dump") else result
Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment): Pydantic AI
- Pydantic AI
- LangChain
- OpenAI Agents
- FastMCP
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = AmplitudeConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
agent = Agent("openai:gpt-4o")
@agent.tool_plain
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
from langchain_core.tools import tool
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = AmplitudeConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
@tool
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
"""Execute Amplitude connector operations."""
result = await connector.execute(entity, action, params or {})
# connector.execute returns a Pydantic envelope for typed actions; fall back to raw data otherwise.
return result.model_dump(mode="json") if hasattr(result, "model_dump") else result
from agents import Agent, function_tool
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = AmplitudeConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
# strict_mode=False because `params: dict` is permissive and the default strict
# JSON schema rejects objects with additionalProperties.
@function_tool(strict_mode=False)
@AmplitudeConnector.tool_utils(framework="openai_agents")
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
"""Execute Amplitude connector operations."""
result = await connector.execute(entity, action, params or {})
return result.model_dump(mode="json") if hasattr(result, "model_dump") else result
agent = Agent(name="Amplitude Assistant", tools=[amplitude_execute])
from fastmcp import FastMCP
from airbyte_agent_sdk.connectors.amplitude import AmplitudeConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig
connector = AmplitudeConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)
mcp = FastMCP("Amplitude Agent")
@mcp.tool
@AmplitudeConnector.tool_utils
async def amplitude_execute(entity: str, action: str, params: dict | None = None):
"""Execute Amplitude connector operations."""
result = await connector.execute(entity, action, params or {})
return result.model_dump(mode="json") if hasattr(result, "model_dump") else result
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": {}}'