Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-freshdesk
[02]
Import
Initialize and use
PYTHON
from airbyte_agent_freshdesk import FreshdeskConnector
from airbyte_agent_freshdesk.models import FreshdeskAuthConfig
connector = FreshdeskConnector(
auth_config=FreshdeskAuthConfig(
api_key="<Your Freshdesk API key (found in Profile Settings)>"
)
)[03]
Tool
Add tools to your agent
python
@agent.tool_plain # assumes you're using Pydantic AI
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Tickets | [List](./REFERENCE.md#tickets-list), [Get](./REFERENCE.md#tickets-get), [Search](./REFERENCE.md#tickets-search) |\n| Contacts | [List](./REFERENCE.md#contacts-list), [Get](./REFERENCE.md#contacts-get) |\n| Agents | [List](./REFERENCE.md#agents-list), [Get](./REFERENCE.md#agents-get), [Search](./REFERENCE.md#agents-search) |\n| Groups | [List](./REFERENCE.md#groups-list), [Get](./REFERENCE.md#groups-get), [Search](./REFERENCE.md#groups-search) |\n| Companies | [List](./REFERENCE.md#companies-list), [Get](./REFERENCE.md#companies-get) |\n| Roles | [List](./REFERENCE.md#roles-list), [Get](./REFERENCE.md#roles-get) |\n| Satisfaction Ratings | [List](./REFERENCE.md#satisfaction-ratings-list) |\n| Surveys | [List](./REFERENCE.md#surveys-list) |\n| Time Entries | [List](./REFERENCE.md#time-entries-list) |\n| Ticket Fields | [List](./REFERENCE.md#ticket-fields-list) |
Example Prompts
Lorem ipsum
List all open tickets in Freshdesk - Show me all agents in the support team - List all groups configured in Freshdesk - Get the details of ticket #26 - Show me all companies in Freshdesk - List all roles defined in the helpdesk - Show me the ticket fields and their options - List time entries for tickets - What are the high priority tickets from last week? - Which tickets have breached their SLA due date? - Show me tickets assigned to agent \{agent_name\} - Find all tickets from company \{company_name\} - How many tickets were created this month by status? - What are the satisfaction ratings for resolved tickets?
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
LangChain
CrewAI
LlamaIndex
AutoGen
OpenAI Agents SDK
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The Freshdesk connector supports API key authentication in open source mode. You provide your Freshdesk API key (found in Profile Settings) directly via the FreshdeskAuthConfig. In hosted mode, credentials are stored securely in Airbyte Cloud and you authenticate using your Airbyte client ID and client secret instead.
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
No, the Freshdesk connector currently only supports read operations. Write operations such as creating tickets, updating ticket status, deleting contacts, or reassigning tickets are explicitly unsupported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Get started in minutes with our open-source connector.