Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-ashby
[02]
Import
Initialize and use
PYTHON
from airbyte_agent_ashby import AshbyConnector
from airbyte_agent_ashby.models import AshbyAuthConfig
connector = AshbyConnector(
auth_config=AshbyAuthConfig(
api_key="<Your Ashby API key>"
)
)[03]
Tool
Add tools to your agent
python
@agent.tool_plain # assumes you're using Pydantic AI
@AshbyConnector.tool_utils
async def ashby_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| Candidates | [List](./REFERENCE.md#candidates-list), [Get](./REFERENCE.md#candidates-get) |\n| Applications | [List](./REFERENCE.md#applications-list), [Get](./REFERENCE.md#applications-get) |\n| Jobs | [List](./REFERENCE.md#jobs-list), [Get](./REFERENCE.md#jobs-get) |\n| Departments | [List](./REFERENCE.md#departments-list), [Get](./REFERENCE.md#departments-get) |\n| Locations | [List](./REFERENCE.md#locations-list), [Get](./REFERENCE.md#locations-get) |\n| Users | [List](./REFERENCE.md#users-list), [Get](./REFERENCE.md#users-get) |\n| Job Postings | [List](./REFERENCE.md#job-postings-list), [Get](./REFERENCE.md#job-postings-get) |\n| Sources | [List](./REFERENCE.md#sources-list) |\n| Archive Reasons | [List](./REFERENCE.md#archive-reasons-list) |\n| Candidate Tags | [List](./REFERENCE.md#candidate-tags-list) |\n| Custom Fields | [List](./REFERENCE.md#custom-fields-list) |\n| Feedback Form Definitions | [List](./REFERENCE.md#feedback-form-definitions-list) |
Example Prompts
Lorem ipsum
List all open jobs - Show me all candidates - List recent applications - List all departments - Show me all job postings - List all users in the organization - Show me candidates who applied last month - What are the top sources for job applications? - Compare the number of applications across different departments - Find candidates with multiple applications - Summarize the candidate pipeline for our latest job posting - Find the most active departments in recruiting this month
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 Ashby connector supports two authentication methods: Open source mode, where you provide an Ashby API key directly via AshbyAuthConfig; and Hosted mode, where credentials are stored securely in Airbyte Cloud and you authenticate using your Airbyte client credentials (client ID and client secret) via AirbyteAuthConfig.
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?
Currently, the Ashby connector focuses on read operations (List and Get). Write operations such as creating job postings, scheduling interviews, updating application statuses, deleting candidate profiles, or sending offer letters are not supported 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.