Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-orb
[02]
Import
Initialize and use
PYTHON
from airbyte_agent_orb import OrbConnector
from airbyte_agent_orb.models import OrbAuthConfig
connector = OrbConnector(
auth_config=OrbAuthConfig(
api_key="<Your Orb API key>"
)
)[03]
Tool
Add tools to your agent
python
@agent.tool_plain # assumes you're using Pydantic AI
@OrbConnector.tool_utils
async def orb_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| Customers | [List](./REFERENCE.md#customers-list), [Get](./REFERENCE.md#customers-get), [Search](./REFERENCE.md#customers-search) |\n| Subscriptions | [List](./REFERENCE.md#subscriptions-list), [Get](./REFERENCE.md#subscriptions-get), [Search](./REFERENCE.md#subscriptions-search) |\n| Plans | [List](./REFERENCE.md#plans-list), [Get](./REFERENCE.md#plans-get), [Search](./REFERENCE.md#plans-search) |\n| Invoices | [List](./REFERENCE.md#invoices-list), [Get](./REFERENCE.md#invoices-get), [Search](./REFERENCE.md#invoices-search) |
Example Prompts
Lorem ipsum
Show me all my customers in Orb - List all active subscriptions - What plans are available? - Show me recent invoices - Show me details for a recent customer - What is the status of a recent subscription? - Show me the pricing details for a plan - Confirm the Stripe ID linked to a customer - What is the payment provider ID for a customer? - List all invoices for a specific customer - List all subscriptions for customer XYZ - Show all active subscriptions for a specific customer - What subscriptions does customer \{external_customer_id\} have? - Pull all invoices from the last month - Show invoices created after \{date\} - List all paid invoices for customer \{customer_id\} - What invoices are in draft status? - Show all issued invoices for subscription \{subscription_id\}
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 Orb connector supports API key authentication in open source mode, where you provide your Orb API key directly. 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?
Currently, the Orb connector focuses on read operations only (List, Get, Search). Write operations such as creating customers, updating subscriptions, deleting records, or sending invoices 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.