jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-19 18:14:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update terminology - Platform and AI agents (#70910)

Browse Source 
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Co-authored-by: octavia-bot[bot] <108746235+octavia-bot[bot]@users.noreply.github.com>
This commit is contained in:
devin-ai-integration[bot]
2025-12-13 22:26:24 +00:00
committed by GitHub
parent a871dadd80
commit b2afd6e91e
39 changed files with 16384 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.markdownlintignore Normal file
View File

@@ -0,0 +1,3 @@
# Ignore auto-generated connector documentation files synced from airbyte-agent-connectors repo
# These files are generated and have formatting that doesn't conform to markdownlint rules
docs/ai-agents/connectors/**

19
docs/ai-agents/README.md
View File

@@ -1,6 +1,16 @@
import Taxonomy from "@site/static/_taxonomy_of_data_movement.md";
---
sidebar_position: 1
---
# Agent engine
# AI agents
Airbyte provides a set of tools to help you automate, understand, move, and work with your data in coordination with AI agents. Some of these tools are standalone open source solutions, and others are paid solutions built on top of Airbyte Cloud.
- **Agent connectors**: Use Airbyte's AI-optimized, type-safe connectors to power your own AI agents, or use them with Airbyte's Connector MCP server. [View the GitHub repo](https://github.com/airbytehq/airbyte-agent-connectors) or [try the tutorial](quickstarts). You can set up your own agent and explore your data in 15 minutes or less.
- **Airbyte Embedded**: Add hundreds of integrations into your product instantly. Your end-users can authenticate into their data sources and begin syncing data to your product. You no longer need to spend engineering cycles on data movement. Focus on what makes your product great, rather than maintaining data integrations.
<!-- import Taxonomy from "@site/static/_taxonomy_of_data_movement.md";
Airbyte's Agent engine is a set of tools to help you automate, understand, move, and work with your data in coordination with AI agents. Some of these tools are standalone open source solutions, and others are pay solutions built on top of Airbyte Cloud.
@@ -39,7 +49,7 @@ The Agent engine is an ideal solution when you:
- Are working with a small amount of data
- Need to trigger side effects, like sending an email or closing a ticket
The agenda data platform _isn't_ ideal when you:
The agentic data platform _isn't_ ideal when you:
- Need all your data in one place
- Need to join across datasets
@@ -60,7 +70,7 @@ If agentic data isn't what you're looking for and you need complex data aggregat
Airbyte Embedded creates isolated workspaces for each of your customers, allowing them to configure their own data sources while keeping their data separate and secure. The Embedded Widget provides a pre-built UI component that handles the entire user onboarding flow from authentication to source configuration.
Once Airbyte enables your organizaton on Airbyte Embedded, you can begin onboarding customers via the Embedded Widget. You can download the Embedded demo app [from GitHub](https://github.com/airbytehq/embedded-demoapp).
Once Airbyte enables your organization on Airbyte Embedded, you can begin onboarding customers via the Embedded Widget. You can download the Embedded demo app [from GitHub](https://github.com/airbytehq/embedded-demoapp).
## Agent connectors
@@ -69,3 +79,4 @@ Airbyte's agent connectors are Python packages that equip AI agents to call thir
## Connector MCP
Use [agent connectors](connectors) to interact with your data using natural language.
-->

146
docs/ai-agents/connectors/asana/CHANGELOG.md Normal file
View File

@@ -0,0 +1,146 @@
# Changelog
## [0.19.10] - 2025-12-13
- Updated connector definition (YAML version 0.1.1)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.19.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.19.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.19.7] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.19.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.19.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.19.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.19.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.19.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.19.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.0)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.19.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.18.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.17.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.16.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.15.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.14.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.13.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.12.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.11.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.10.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.9.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.8.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.7.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.6.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.5.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 430a4e68
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: cd499acd
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: b261c3a2
- SDK version: 0.1.0

82
docs/ai-agents/connectors/asana/README.md Normal file
View File

@@ -0,0 +1,82 @@
# Airbyte Asana AI Connector
Asana is a work management platform that helps teams organize, track, and manage
projects and tasks. This connector provides access to tasks, projects, workspaces,
teams, and users for project tracking, workload analysis, and productivity insights.
## Example Questions
- What tasks are assigned to me this week?
- List all projects in my workspace
- Summarize my team's workload and task completion rates
- Show me the tasks for the [ProjectName] project
- Who are the team members in my [TeamName] team?
- Find all tasks related to [ClientName] across my workspaces
- Analyze the most active projects in my workspace last month
- Compare task completion rates between my different teams
- Identify overdue tasks across all my projects
- Show me details of my current workspace and its users
## Unsupported Questions
- Create a new task for [TeamMember]
- Update the priority of this task
- Delete the project [ProjectName]
- Schedule a new team meeting
- Add a new team member to [Workspace]
- Move this task to another project
## Installation
```bash
uv pip install airbyte-ai-asana
```
## Usage
```python
from airbyte_ai_asana import AsanaConnector, AsanaAuthConfig
connector = AsanaConnector(
auth_config=AsanaAuthConfig(
access_token="...",
refresh_token="...",
client_id="...",
client_secret="..."
)
)
result = connector.tasks.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Tasks | [List](./REFERENCE.md#tasks-list), [Get](./REFERENCE.md#tasks-get) |
| Project Tasks | [List](./REFERENCE.md#project-tasks-list) |
| Workspace Task Search | [List](./REFERENCE.md#workspace-task-search-list) |
| Projects | [List](./REFERENCE.md#projects-list), [Get](./REFERENCE.md#projects-get) |
| Task Projects | [List](./REFERENCE.md#task-projects-list) |
| Team Projects | [List](./REFERENCE.md#team-projects-list) |
| Workspace Projects | [List](./REFERENCE.md#workspace-projects-list) |
| Workspaces | [List](./REFERENCE.md#workspaces-list), [Get](./REFERENCE.md#workspaces-get) |
| Users | [List](./REFERENCE.md#users-list), [Get](./REFERENCE.md#users-get) |
| Workspace Users | [List](./REFERENCE.md#workspace-users-list) |
| Team Users | [List](./REFERENCE.md#team-users-list) |
| Teams | [Get](./REFERENCE.md#teams-get) |
| Workspace Teams | [List](./REFERENCE.md#workspace-teams-list) |
| User Teams | [List](./REFERENCE.md#user-teams-list) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Asana API Reference](https://developers.asana.com/reference/rest-api-reference).
## Version Information
**Package Version:** 0.19.10
**Connector Version:** 0.1.1
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

1129
docs/ai-agents/connectors/asana/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

141
docs/ai-agents/connectors/github/CHANGELOG.md Normal file
View File

@@ -0,0 +1,141 @@
# Changelog
## [0.18.10] - 2025-12-13
- Updated connector definition (YAML version 0.1.1)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.18.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.18.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.18.7] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.18.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.18.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.18.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.18.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.18.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.18.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.0)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.18.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.17.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.16.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.15.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.14.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.13.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.12.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.11.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.10.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.9.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.8.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.7.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.6.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.5.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 430a4e68
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: b261c3a2
- SDK version: 0.1.0

87
docs/ai-agents/connectors/github/README.md Normal file
View File

@@ -0,0 +1,87 @@
# Airbyte Github AI Connector
GitHub is a platform for version control and collaborative software development
using Git. This connector provides access to repositories, branches, commits, issues,
pull requests, reviews, comments, releases, organizations, teams, and users for
development workflow analysis and project management insights.
## Example Questions
- Show me all open issues in my repositories this month
- List the top 5 repositories I've starred recently
- Analyze the commit trends in my main project over the last quarter
- Find all pull requests created by [teamMember] in the past two weeks
- Search for repositories related to machine learning in my organizations
- Compare the number of contributors across my different team projects
- Identify the most active branches in my main repository
- Get details about the most recent releases in my organization
- List all milestones for our current development sprint
- Show me insights about pull request review patterns in our team
## Unsupported Questions
- Create a new issue in the project repository
- Update the status of this pull request
- Delete an old branch from the repository
- Schedule a team review for this code
- Assign a new label to this issue
## Installation
```bash
uv pip install airbyte-ai-github
```
## Usage
```python
from airbyte_ai_github import GithubConnector, GithubAuthConfig
connector = GithubConnector(
auth_config=GithubAuthConfig(
access_token="...",
refresh_token="...",
client_id="...",
client_secret="..."
)
)
result = connector.repositories.get()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Repositories | [Get](./REFERENCE.md#repositories-get), [List](./REFERENCE.md#repositories-list), [Search](./REFERENCE.md#repositories-search) |
| Org Repositories | [List](./REFERENCE.md#org-repositories-list) |
| Branches | [List](./REFERENCE.md#branches-list), [Get](./REFERENCE.md#branches-get) |
| Commits | [List](./REFERENCE.md#commits-list), [Get](./REFERENCE.md#commits-get) |
| Releases | [List](./REFERENCE.md#releases-list), [Get](./REFERENCE.md#releases-get) |
| Issues | [List](./REFERENCE.md#issues-list), [Get](./REFERENCE.md#issues-get), [Search](./REFERENCE.md#issues-search) |
| Pull Requests | [List](./REFERENCE.md#pull-requests-list), [Get](./REFERENCE.md#pull-requests-get), [Search](./REFERENCE.md#pull-requests-search) |
| Reviews | [List](./REFERENCE.md#reviews-list) |
| Comments | [List](./REFERENCE.md#comments-list), [Get](./REFERENCE.md#comments-get) |
| Pr Comments | [List](./REFERENCE.md#pr-comments-list), [Get](./REFERENCE.md#pr-comments-get) |
| Labels | [List](./REFERENCE.md#labels-list), [Get](./REFERENCE.md#labels-get) |
| Milestones | [List](./REFERENCE.md#milestones-list), [Get](./REFERENCE.md#milestones-get) |
| Organizations | [Get](./REFERENCE.md#organizations-get), [List](./REFERENCE.md#organizations-list) |
| Users | [Get](./REFERENCE.md#users-get), [List](./REFERENCE.md#users-list), [Search](./REFERENCE.md#users-search) |
| Teams | [List](./REFERENCE.md#teams-list), [Get](./REFERENCE.md#teams-get) |
| Tags | [List](./REFERENCE.md#tags-list), [Get](./REFERENCE.md#tags-get) |
| Stargazers | [List](./REFERENCE.md#stargazers-list) |
| Viewer | [Get](./REFERENCE.md#viewer-get) |
| Viewer Repositories | [List](./REFERENCE.md#viewer-repositories-list) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Github API Reference](https://docs.github.com/en/rest).
## Version Information
**Package Version:** 0.18.10
**Connector Version:** 0.1.1
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

1616
docs/ai-agents/connectors/github/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

156
docs/ai-agents/connectors/gong/CHANGELOG.md Normal file
View File

@@ -0,0 +1,156 @@
# Changelog
## [0.19.12] - 2025-12-13
- Updated connector definition (YAML version 0.1.3)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.19.11] - 2025-12-12
- Updated connector definition (YAML version 0.1.3)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.19.10] - 2025-12-12
- Updated connector definition (YAML version 0.1.3)
- Source commit: 87a2243c
- SDK version: 0.1.0
## [0.19.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.2)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.19.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.2)
- Source commit: 751920d7
- SDK version: 0.1.0
## [0.19.7] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 38493f4d
- SDK version: 0.1.0
## [0.19.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.19.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.19.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.19.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.19.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.19.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.0)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.19.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.18.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.17.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.16.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.15.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.14.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.13.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.12.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.11.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.10.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.9.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.8.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.7.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.6.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.5.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 430a4e68
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: cd499acd
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: b261c3a2
- SDK version: 0.1.0

81
docs/ai-agents/connectors/gong/README.md Normal file
View File

@@ -0,0 +1,81 @@
# Airbyte Gong AI Connector
Gong is a revenue intelligence platform that captures and analyzes customer interactions
across calls, emails, and web conferences. This connector provides access to users,
recorded calls with transcripts, activity statistics, scorecards, trackers, workspaces,
coaching metrics, and library content for sales performance analysis and revenue insights.
## Example Questions
- List all users in my Gong account
- Show me calls from last week
- Get the transcript for call abc123
- What are the activity stats for our sales team?
- List all workspaces in Gong
- Show me the scorecard configurations
- What trackers are set up in my account?
- Get coaching metrics for manager user123
## Unsupported Questions
- Create a new user in Gong
- Delete a call recording
- Update scorecard questions
- Schedule a new meeting
- Send feedback to a team member
- Modify tracker keywords
## Installation
```bash
uv pip install airbyte-ai-gong
```
## Usage
```python
from airbyte_ai_gong import GongConnector, GongAuthConfig
connector = GongConnector(
auth_config=GongAuthConfig(
access_key="...",
access_key_secret="..."
)
)
result = connector.users.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Users | [List](./REFERENCE.md#users-list), [Get](./REFERENCE.md#users-get) |
| Calls | [List](./REFERENCE.md#calls-list), [Get](./REFERENCE.md#calls-get) |
| Calls Extensive | [List](./REFERENCE.md#calls-extensive-list) |
| Call Audio | [Download](./REFERENCE.md#call-audio-download) |
| Call Video | [Download](./REFERENCE.md#call-video-download) |
| Workspaces | [List](./REFERENCE.md#workspaces-list) |
| Call Transcripts | [List](./REFERENCE.md#call-transcripts-list) |
| Stats Activity Aggregate | [List](./REFERENCE.md#stats-activity-aggregate-list) |
| Stats Activity Day By Day | [List](./REFERENCE.md#stats-activity-day-by-day-list) |
| Stats Interaction | [List](./REFERENCE.md#stats-interaction-list) |
| Settings Scorecards | [List](./REFERENCE.md#settings-scorecards-list) |
| Settings Trackers | [List](./REFERENCE.md#settings-trackers-list) |
| Library Folders | [List](./REFERENCE.md#library-folders-list) |
| Library Folder Content | [List](./REFERENCE.md#library-folder-content-list) |
| Coaching | [List](./REFERENCE.md#coaching-list) |
| Stats Activity Scorecards | [List](./REFERENCE.md#stats-activity-scorecards-list) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Gong API Reference](https://gong.app.gong.io/settings/api/documentation).
## Version Information
**Package Version:** 0.19.12
**Connector Version:** 0.1.3
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

1217
docs/ai-agents/connectors/gong/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

136
docs/ai-agents/connectors/greenhouse/CHANGELOG.md Normal file
View File

@@ -0,0 +1,136 @@
# Changelog
## [0.17.10] - 2025-12-13
- Updated connector definition (YAML version 0.1.1)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.17.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.17.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.17.7] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.17.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.17.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.17.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.17.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.17.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.17.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.0)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.17.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.16.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.15.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.14.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.13.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.12.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.11.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.10.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.9.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.8.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.7.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.6.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.5.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: b261c3a2
- SDK version: 0.1.0

78
docs/ai-agents/connectors/greenhouse/README.md Normal file
View File

@@ -0,0 +1,78 @@
# Airbyte Greenhouse AI Connector
Greenhouse is an applicant tracking system (ATS) that helps companies manage their
hiring process. This connector provides access to candidates, applications, jobs,
offers, users, departments, offices, job posts, sources, and scheduled interviews
for recruiting analytics and talent acquisition insights.
## Example Questions
- Show me candidates from [Company] who applied last month
- What are the top 5 sources for our job applications this quarter?
- List all open jobs in the Sales department
- Analyze the interview schedules for our engineering candidates this week
- Get details of recent job offers for [teamMember]
- Compare the number of applications across different offices
- Identify candidates who have multiple applications in our system
- Show me upcoming scheduled interviews for our marketing positions
- Summarize the candidate pipeline for our latest job posting
- Find the most active departments in recruiting this month
## Unsupported Questions
- Create a new job posting for the marketing team
- Schedule an interview for [candidate]
- Update the status of [candidate]'s application
- Delete a candidate profile
- Send an offer letter to [candidate]
- Edit the details of a job description
## Installation
```bash
uv pip install airbyte-ai-greenhouse
```
## Usage
```python
from airbyte_ai_greenhouse import GreenhouseConnector, GreenhouseAuthConfig
connector = GreenhouseConnector(
auth_config=GreenhouseAuthConfig(
api_key="..."
)
)
result = connector.candidates.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Candidates | [List](./REFERENCE.md#candidates-list), [Get](./REFERENCE.md#candidates-get) |
| Applications | [List](./REFERENCE.md#applications-list), [Get](./REFERENCE.md#applications-get) |
| Jobs | [List](./REFERENCE.md#jobs-list), [Get](./REFERENCE.md#jobs-get) |
| Offers | [List](./REFERENCE.md#offers-list), [Get](./REFERENCE.md#offers-get) |
| Users | [List](./REFERENCE.md#users-list), [Get](./REFERENCE.md#users-get) |
| Departments | [List](./REFERENCE.md#departments-list), [Get](./REFERENCE.md#departments-get) |
| Offices | [List](./REFERENCE.md#offices-list), [Get](./REFERENCE.md#offices-get) |
| Job Posts | [List](./REFERENCE.md#job-posts-list), [Get](./REFERENCE.md#job-posts-get) |
| Sources | [List](./REFERENCE.md#sources-list) |
| Scheduled Interviews | [List](./REFERENCE.md#scheduled-interviews-list), [Get](./REFERENCE.md#scheduled-interviews-get) |
| Application Attachment | [Download](./REFERENCE.md#application-attachment-download) |
| Candidate Attachment | [Download](./REFERENCE.md#candidate-attachment-download) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Greenhouse API Reference](https://developers.greenhouse.io/harvest.html).
## Version Information
**Package Version:** 0.17.10
**Connector Version:** 0.1.1
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

1048
docs/ai-agents/connectors/greenhouse/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

131
docs/ai-agents/connectors/hubspot/CHANGELOG.md Normal file
View File

@@ -0,0 +1,131 @@
# Changelog
## [0.15.11] - 2025-12-13
- Updated connector definition (YAML version 0.1.2)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.15.10] - 2025-12-12
- Updated connector definition (YAML version 0.1.2)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.15.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.15.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.15.7] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.15.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.15.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.15.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.15.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.15.2] - 2025-12-10
- Updated connector definition (YAML version 0.1.1)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.15.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.1)
- Source commit: 32ed3114
- SDK version: 0.1.0
## [0.15.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.14.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.13.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.12.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.11.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.10.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.9.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.8.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.7.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.6.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.5.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0

71
docs/ai-agents/connectors/hubspot/README.md Normal file
View File

@@ -0,0 +1,71 @@
# Airbyte Hubspot AI Connector
HubSpot is a CRM platform that provides tools for marketing, sales, customer service,
and content management. This connector provides access to contacts, companies, deals,
tickets, and custom objects for customer relationship management and sales analytics.
## Example Questions
- Show me all deals from [Company] this quarter
- What are the top 5 most valuable deals in my pipeline right now?
- List recent tickets from [customerX] and analyze their support trends
- Search for contacts in the marketing department at [Company]
- Give me an overview of my sales team's deals in the last 30 days
- Identify the most active companies in our CRM this month
- Compare the number of deals closed by different sales representatives
- Find all tickets related to a specific product issue and summarize their status
## Unsupported Questions
- Create a new contact record for [personX]
- Update the contact information for [customerY]
- Delete the ticket from last week's support case
- Schedule a follow-up task for this deal
- Send an email to all contacts in the sales pipeline
## Installation
```bash
uv pip install airbyte-ai-hubspot
```
## Usage
```python
from airbyte_ai_hubspot import HubspotConnector, HubspotAuthConfig
connector = HubspotConnector(
auth_config=HubspotAuthConfig(
client_id="...",
client_secret="...",
refresh_token="...",
access_token="..."
)
)
result = connector.contacts.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Contacts | [List](./REFERENCE.md#contacts-list), [Get](./REFERENCE.md#contacts-get), [Search](./REFERENCE.md#contacts-search) |
| Companies | [List](./REFERENCE.md#companies-list), [Get](./REFERENCE.md#companies-get), [Search](./REFERENCE.md#companies-search) |
| Deals | [List](./REFERENCE.md#deals-list), [Get](./REFERENCE.md#deals-get), [Search](./REFERENCE.md#deals-search) |
| Tickets | [List](./REFERENCE.md#tickets-list), [Get](./REFERENCE.md#tickets-get), [Search](./REFERENCE.md#tickets-search) |
| Schemas | [List](./REFERENCE.md#schemas-list), [Get](./REFERENCE.md#schemas-get) |
| Objects | [List](./REFERENCE.md#objects-list), [Get](./REFERENCE.md#objects-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Hubspot API Reference](https://developers.hubspot.com/docs/api/crm/understanding-the-crm).
## Version Information
**Package Version:** 0.15.11
**Connector Version:** 0.1.2
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

1114
docs/ai-agents/connectors/hubspot/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

11
docs/ai-agents/connectors/jira/CHANGELOG.md Normal file
View File

@@ -0,0 +1,11 @@
# Changelog
## [0.1.1] - 2025-12-13
- Updated connector definition (YAML version 1.0.2)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.1.0] - 2025-12-12
- Updated connector definition (YAML version 1.0.2)
- Source commit: 61d98c0a
- SDK version: 0.1.0

47
docs/ai-agents/connectors/jira/README.md Normal file
View File

@@ -0,0 +1,47 @@
# Airbyte Jira AI Connector
Connector for Jira API
## Installation
```bash
uv pip install airbyte-ai-jira
```
## Usage
```python
from airbyte_ai_jira import JiraConnector, JiraAuthConfig
connector = JiraConnector(
auth_config=JiraAuthConfig(
username="...",
password="..."
)
)
result = connector.issues.search()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Issues | [Search](./REFERENCE.md#issues-search), [Get](./REFERENCE.md#issues-get) |
| Projects | [Search](./REFERENCE.md#projects-search), [Get](./REFERENCE.md#projects-get) |
| Users | [Get](./REFERENCE.md#users-get), [List](./REFERENCE.md#users-list), [Search](./REFERENCE.md#users-search) |
| Issue Fields | [List](./REFERENCE.md#issue-fields-list), [Search](./REFERENCE.md#issue-fields-search) |
| Issue Comments | [List](./REFERENCE.md#issue-comments-list), [Get](./REFERENCE.md#issue-comments-get) |
| Issue Worklogs | [List](./REFERENCE.md#issue-worklogs-list), [Get](./REFERENCE.md#issue-worklogs-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Jira API Reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/).
## Version Information
**Package Version:** 0.1.1
**Connector Version:** 1.0.2
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

827
docs/ai-agents/connectors/jira/REFERENCE.md Normal file
View File

@@ -0,0 +1,827 @@
# Jira
## Supported Entities and Actions
| Entity | Actions |
|--------|---------|
| Issues | [Search](#issues-search), [Get](#issues-get) |
| Projects | [Search](#projects-search), [Get](#projects-get) |
| Users | [Get](#users-get), [List](#users-list), [Search](#users-search) |
| Issue Fields | [List](#issue-fields-list), [Search](#issue-fields-search) |
| Issue Comments | [List](#issue-comments-list), [Get](#issue-comments-get) |
| Issue Worklogs | [List](#issue-worklogs-list), [Get](#issue-worklogs-get) |
### Issues
#### Issues Search
Retrieve issues based on JQL query with pagination support
**Python SDK**
```python
jira.issues.search()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "search"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `jql` | `string` | No | JQL query string to filter issues |
| `nextPageToken` | `string` | No | The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the `nextPageToken` to fetch the next page of issues. The `nextPageToken` field is not included in the response for the last page, indicating there is no next page. |
| `maxResults` | `integer` | No | The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields or properties are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only. It returns max 5000 issues. |
| `fields` | `string` | No | A comma-separated list of fields to return for each issue. By default, all navigable fields are returned. To get a list of all fields, use the Get fields operation. |
| `expand` | `string` | No | A comma-separated list of parameters to expand. This parameter accepts multiple values, including `renderedFields`, `names`, `schema`, `transitions`, `operations`, `editmeta`, `changelog`, and `versionedRepresentations`. |
| `properties` | `string` | No | A comma-separated list of issue property keys. To get a list of all issue property keys, use the Get issue operation. A maximum of 5 properties can be requested. |
| `fieldsByKeys` | `boolean` | No | Whether the fields parameter contains field keys (true) or field IDs (false). Default is false. |
| `failFast` | `boolean` | No | Fail the request early if all field data cannot be retrieved. Default is false. |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `key` | `string` | |
| `self` | `string` | |
| `expand` | `string \| null` | |
| `fields` | `object` | |
**Meta**
| Field Name | Type | Description |
|------------|------|-------------|
| `nextPageToken` | `string \| null` | |
| `isLast` | `boolean \| null` | |
| `total` | `integer` | |
</details>
#### Issues Get
Retrieve a single issue by its ID or key
**Python SDK**
```python
jira.issues.get(
issue_id_or_key="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "get",
"params": {
"issueIdOrKey": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `issueIdOrKey` | `string` | Yes | The issue ID or key (e.g., "PROJ-123" or "10000") |
| `fields` | `string` | No | A comma-separated list of fields to return for the issue. By default, all navigable and Jira default fields are returned. Use it to retrieve a subset of fields. |
| `expand` | `string` | No | A comma-separated list of parameters to expand. This parameter accepts multiple values, including `renderedFields`, `names`, `schema`, `transitions`, `operations`, `editmeta`, `changelog`, and `versionedRepresentations`. |
| `properties` | `string` | No | A comma-separated list of issue property keys. To get a list of all issue property keys, use the Get issue operation. A maximum of 5 properties can be requested. |
| `fieldsByKeys` | `boolean` | No | Whether the fields parameter contains field keys (true) or field IDs (false). Default is false. |
| `updateHistory` | `boolean` | No | Whether the action taken is added to the user's Recent history. Default is false. |
| `failFast` | `boolean` | No | Fail the request early if all field data cannot be retrieved. Default is false. |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `key` | `string` | |
| `self` | `string` | |
| `expand` | `string \| null` | |
| `fields` | `object` | |
</details>
### Projects
#### Projects Search
Search and filter projects with advanced query parameters
**Python SDK**
```python
jira.projects.search()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "projects",
"action": "search"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `startAt` | `integer` | No | The index of the first item to return in a page of results (page offset) |
| `maxResults` | `integer` | No | The maximum number of items to return per page (max 100) |
| `orderBy` | `"category" \| "-category" \| "+category" \| "key" \| "-key" \| "+key" \| "name" \| "-name" \| "+name" \| "owner" \| "-owner" \| "+owner" \| "issueCount" \| "-issueCount" \| "+issueCount" \| "lastIssueUpdatedDate" \| "-lastIssueUpdatedDate" \| "+lastIssueUpdatedDate" \| "archivedDate" \| "+archivedDate" \| "-archivedDate" \| "deletedDate" \| "+deletedDate" \| "-deletedDate"` | No | Order the results by a field (prefix with + for ascending, - for descending) |
| `id` | `array<integer>` | No | Filter by project IDs (up to 50) |
| `keys` | `array<string>` | No | Filter by project keys (up to 50) |
| `query` | `string` | No | Filter using a literal string (matches project key or name, case insensitive) |
| `typeKey` | `string` | No | Filter by project type (comma-separated) |
| `categoryId` | `integer` | No | Filter by project category ID |
| `action` | `"view" \| "browse" \| "edit" \| "create"` | No | Filter by user permission (view, browse, edit, create) |
| `expand` | `string` | No | Comma-separated list of additional fields (description, projectKeys, lead, issueTypes, url, insight) |
| `status` | `array<"live" \| "archived" \| "deleted">` | No | EXPERIMENTAL - Filter by project status |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `key` | `string` | |
| `name` | `string` | |
| `self` | `string` | |
| `expand` | `string \| null` | |
| `description` | `string \| null` | |
| `lead` | `object \| null` | |
| `avatarUrls` | `object` | |
| `projectTypeKey` | `string` | |
| `simplified` | `boolean` | |
| `style` | `string` | |
| `isPrivate` | `boolean` | |
| `properties` | `object` | |
| `projectCategory` | `object \| null` | |
| `entityId` | `string \| null` | |
| `uuid` | `string \| null` | |
| `url` | `string \| null` | |
| `assigneeType` | `string \| null` | |
| `components` | `array \| null` | |
| `issueTypes` | `array \| null` | |
| `versions` | `array \| null` | |
| `roles` | `object \| null` | |
**Meta**
| Field Name | Type | Description |
|------------|------|-------------|
| `nextPage` | `string \| null` | |
| `total` | `integer` | |
</details>
#### Projects Get
Retrieve a single project by its ID or key
**Python SDK**
```python
jira.projects.get(
project_id_or_key="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "projects",
"action": "get",
"params": {
"projectIdOrKey": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `projectIdOrKey` | `string` | Yes | The project ID or key (e.g., "PROJ" or "10000") |
| `expand` | `string` | No | Comma-separated list of additional fields to include (description, projectKeys, lead, issueTypes, url, insight) |
| `properties` | `string` | No | A comma-separated list of project property keys to return. To get a list of all project property keys, use Get project property keys. |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `key` | `string` | |
| `name` | `string` | |
| `self` | `string` | |
| `expand` | `string \| null` | |
| `description` | `string \| null` | |
| `lead` | `object \| null` | |
| `avatarUrls` | `object` | |
| `projectTypeKey` | `string` | |
| `simplified` | `boolean` | |
| `style` | `string` | |
| `isPrivate` | `boolean` | |
| `properties` | `object` | |
| `projectCategory` | `object \| null` | |
| `entityId` | `string \| null` | |
| `uuid` | `string \| null` | |
| `url` | `string \| null` | |
| `assigneeType` | `string \| null` | |
| `components` | `array \| null` | |
| `issueTypes` | `array \| null` | |
| `versions` | `array \| null` | |
| `roles` | `object \| null` | |
</details>
### Users
#### Users Get
Retrieve a single user by their account ID
**Python SDK**
```python
jira.users.get(
account_id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "get",
"params": {
"accountId": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `accountId` | `string` | Yes | The account ID of the user |
| `expand` | `string` | No | Comma-separated list of additional fields to include (groups, applicationRoles) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `self` | `string` | |
| `accountId` | `string` | |
| `accountType` | `string` | |
| `emailAddress` | `string \| null` | |
| `avatarUrls` | `object` | |
| `displayName` | `string` | |
| `active` | `boolean` | |
| `timeZone` | `string \| null` | |
| `locale` | `string \| null` | |
| `expand` | `string \| null` | |
| `groups` | `object \| null` | |
| `applicationRoles` | `object \| null` | |
</details>
#### Users List
Returns a paginated list of users
**Python SDK**
```python
jira.users.list()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "list"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `startAt` | `integer` | No | The index of the first item to return in a page of results (page offset) |
| `maxResults` | `integer` | No | The maximum number of items to return per page (max 1000) |
#### Users Search
Search for users using a query string
**Python SDK**
```python
jira.users.search()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "users",
"action": "search"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `query` | `string` | No | A query string to search for users (matches display name, email, account ID) |
| `startAt` | `integer` | No | The index of the first item to return in a page of results (page offset) |
| `maxResults` | `integer` | No | The maximum number of items to return per page (max 1000) |
| `accountId` | `string` | No | Filter by account IDs (supports multiple values) |
| `property` | `string` | No | Property key to filter users |
### Issue Fields
#### Issue Fields List
Returns a list of all custom and system fields
**Python SDK**
```python
jira.issue_fields.list()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issue_fields",
"action": "list"
}'
```
#### Issue Fields Search
Search and filter issue fields with query parameters
**Python SDK**
```python
jira.issue_fields.search()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issue_fields",
"action": "search"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `startAt` | `integer` | No | The index of the first item to return in a page of results (page offset) |
| `maxResults` | `integer` | No | The maximum number of items to return per page (max 100) |
| `type` | `array<"custom" \| "system">` | No | The type of fields to search for (custom, system, or both) |
| `id` | `array<string>` | No | List of field IDs to search for |
| `query` | `string` | No | String to match against field names, descriptions, and field IDs (case insensitive) |
| `orderBy` | `"contextsCount" \| "-contextsCount" \| "+contextsCount" \| "lastUsed" \| "-lastUsed" \| "+lastUsed" \| "name" \| "-name" \| "+name" \| "screensCount" \| "-screensCount" \| "+screensCount"` | No | Order the results by a field (contextsCount, lastUsed, name, screensCount) |
| `expand` | `string` | No | Comma-separated list of additional fields to include (searcherKey, screensCount, contextsCount, isLocked, lastUsed) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `maxResults` | `integer` | |
| `startAt` | `integer` | |
| `total` | `integer` | |
| `isLast` | `boolean` | |
| `values` | `array<object>` | |
| `values[].id` | `string` | |
| `values[].key` | `string \| null` | |
| `values[].name` | `string` | |
| `values[].custom` | `boolean \| null` | |
| `values[].orderable` | `boolean \| null` | |
| `values[].navigable` | `boolean \| null` | |
| `values[].searchable` | `boolean \| null` | |
| `values[].clauseNames` | `array \| null` | |
| `values[].schema` | `object \| null` | |
| `values[].untranslatedName` | `string \| null` | |
| `values[].typeDisplayName` | `string \| null` | |
| `values[].description` | `string \| null` | |
| `values[].searcherKey` | `string \| null` | |
| `values[].screensCount` | `integer \| null` | |
| `values[].contextsCount` | `integer \| null` | |
| `values[].isLocked` | `boolean \| null` | |
| `values[].lastUsed` | `string \| null` | |
</details>
### Issue Comments
#### Issue Comments List
Retrieve all comments for a specific issue
**Python SDK**
```python
jira.issue_comments.list(
issue_id_or_key="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issue_comments",
"action": "list",
"params": {
"issueIdOrKey": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `issueIdOrKey` | `string` | Yes | The issue ID or key (e.g., "PROJ-123" or "10000") |
| `startAt` | `integer` | No | The index of the first item to return in a page of results (page offset) |
| `maxResults` | `integer` | No | The maximum number of items to return per page |
| `orderBy` | `"created" \| "-created" \| "+created"` | No | Order the results by created date (+ for ascending, - for descending) |
| `expand` | `string` | No | Comma-separated list of additional fields to include (renderedBody, properties) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `self` | `string` | |
| `body` | `object` | |
| `author` | `object` | |
| `updateAuthor` | `object` | |
| `created` | `string` | |
| `updated` | `string` | |
| `jsdPublic` | `boolean` | |
| `visibility` | `object \| null` | |
| `renderedBody` | `string \| null` | |
| `properties` | `array \| null` | |
**Meta**
| Field Name | Type | Description |
|------------|------|-------------|
| `startAt` | `integer` | |
| `maxResults` | `integer` | |
| `total` | `integer` | |
</details>
#### Issue Comments Get
Retrieve a single comment by its ID
**Python SDK**
```python
jira.issue_comments.get(
issue_id_or_key="<str>",
comment_id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issue_comments",
"action": "get",
"params": {
"issueIdOrKey": "<str>",
"commentId": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `issueIdOrKey` | `string` | Yes | The issue ID or key (e.g., "PROJ-123" or "10000") |
| `commentId` | `string` | Yes | The comment ID |
| `expand` | `string` | No | Comma-separated list of additional fields to include (renderedBody, properties) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `self` | `string` | |
| `body` | `object` | |
| `author` | `object` | |
| `updateAuthor` | `object` | |
| `created` | `string` | |
| `updated` | `string` | |
| `jsdPublic` | `boolean` | |
| `visibility` | `object \| null` | |
| `renderedBody` | `string \| null` | |
| `properties` | `array \| null` | |
</details>
### Issue Worklogs
#### Issue Worklogs List
Retrieve all worklogs for a specific issue
**Python SDK**
```python
jira.issue_worklogs.list(
issue_id_or_key="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issue_worklogs",
"action": "list",
"params": {
"issueIdOrKey": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `issueIdOrKey` | `string` | Yes | The issue ID or key (e.g., "PROJ-123" or "10000") |
| `startAt` | `integer` | No | The index of the first item to return in a page of results (page offset) |
| `maxResults` | `integer` | No | The maximum number of items to return per page |
| `expand` | `string` | No | Comma-separated list of additional fields to include (properties) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `self` | `string` | |
| `author` | `object` | |
| `updateAuthor` | `object` | |
| `comment` | `object` | |
| `created` | `string` | |
| `updated` | `string` | |
| `started` | `string` | |
| `timeSpent` | `string` | |
| `timeSpentSeconds` | `integer` | |
| `issueId` | `string` | |
| `visibility` | `object \| null` | |
| `properties` | `array \| null` | |
**Meta**
| Field Name | Type | Description |
|------------|------|-------------|
| `startAt` | `integer` | |
| `maxResults` | `integer` | |
| `total` | `integer` | |
</details>
#### Issue Worklogs Get
Retrieve a single worklog by its ID
**Python SDK**
```python
jira.issue_worklogs.get(
issue_id_or_key="<str>",
worklog_id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issue_worklogs",
"action": "get",
"params": {
"issueIdOrKey": "<str>",
"worklogId": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `issueIdOrKey` | `string` | Yes | The issue ID or key (e.g., "PROJ-123" or "10000") |
| `worklogId` | `string` | Yes | The worklog ID |
| `expand` | `string` | No | Comma-separated list of additional fields to include (properties) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `id` | `string` | |
| `self` | `string` | |
| `author` | `object` | |
| `updateAuthor` | `object` | |
| `comment` | `object` | |
| `created` | `string` | |
| `updated` | `string` | |
| `started` | `string` | |
| `timeSpent` | `string` | |
| `timeSpentSeconds` | `integer` | |
| `issueId` | `string` | |
| `visibility` | `object \| null` | |
| `properties` | `array \| null` | |
</details>
## Configuration
The connector requires the following configuration variables:
| Variable | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
| `subdomain` | `string` | Yes | `{subdomain}` | Your Jira Cloud subdomain |
These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
## Authentication
The Jira connector supports the following authentication methods:
### Authentication
| Field Name | Type | Required | Description |
|------------|------|----------|-------------|
| `username` | `str` | Yes | Authentication username |
| `password` | `str` | Yes | Authentication password |
#### Example
**Python SDK**
```python
JiraConnector(
auth_config=JiraAuthConfig(
username="<Authentication username>",
password="<Authentication password>"
)
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"connector_definition_id": "68e63de2-bb83-4c7e-93fa-a8a9051e3993",
"auth_config": {
"username": "<Authentication username>",
"password": "<Authentication password>"
},
"name": "My Jira Connector"
}'
```

146
docs/ai-agents/connectors/linear/CHANGELOG.md Normal file
View File

@@ -0,0 +1,146 @@
# Changelog
## [0.19.10] - 2025-12-13
- Updated connector definition (YAML version 0.1.1)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.19.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.19.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.19.7] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.19.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.19.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.19.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.19.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.19.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.19.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.0)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.19.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.18.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.17.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.16.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.15.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.14.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.13.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.12.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.11.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.10.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.9.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.8.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.7.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.6.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.5.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 430a4e68
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: cd499acd
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: b261c3a2
- SDK version: 0.1.0

67
docs/ai-agents/connectors/linear/README.md Normal file
View File

@@ -0,0 +1,67 @@
# Airbyte Linear AI Connector
Linear is a modern issue tracking and project management tool built for software
development teams. This connector provides access to issues, projects, and teams
for sprint planning, backlog management, and development workflow analysis.
## Example Questions
- Show me the open issues assigned to my team this week
- List out all projects I'm currently involved in
- Analyze the workload distribution across my development team
- What are the top priority issues in our current sprint?
- Identify the most active projects in our organization right now
- Summarize the recent issues for [teamMember] in the last two weeks
- Compare the issue complexity across different teams
- Which projects have the most unresolved issues?
- Give me an overview of my team's current project backlog
## Unsupported Questions
- Create a new issue for the backend team
- Update the priority of this specific issue
- Assign a team member to this project
- Delete an outdated project from our workspace
- Schedule a sprint planning meeting
- Move an issue to a different project
## Installation
```bash
uv pip install airbyte-ai-linear
```
## Usage
```python
from airbyte_ai_linear import LinearConnector, LinearAuthConfig
connector = LinearConnector(
auth_config=LinearAuthConfig(
api_key="..."
)
)
result = connector.issues.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Issues | [List](./REFERENCE.md#issues-list), [Get](./REFERENCE.md#issues-get) |
| Projects | [List](./REFERENCE.md#projects-list), [Get](./REFERENCE.md#projects-get) |
| Teams | [List](./REFERENCE.md#teams-list), [Get](./REFERENCE.md#teams-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Linear API Reference](https://linear.app/developers/graphql).
## Version Information
**Package Version:** 0.19.10
**Connector Version:** 0.1.1
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

326
docs/ai-agents/connectors/linear/REFERENCE.md Normal file
View File

@@ -0,0 +1,326 @@
# Linear
## Supported Entities and Actions
| Entity | Actions |
|--------|---------|
| Issues | [List](#issues-list), [Get](#issues-get) |
| Projects | [List](#projects-list), [Get](#projects-get) |
| Teams | [List](#teams-list), [Get](#teams-get) |
### Issues
#### Issues List
Returns a paginated list of issues via GraphQL with pagination support
**Python SDK**
```python
linear.issues.list()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "list"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `first` | `integer` | No | Number of items to return (max 250) |
| `after` | `string` | No | Cursor to start after (for pagination) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `object` | |
</details>
#### Issues Get
Get a single issue by ID via GraphQL
**Python SDK**
```python
linear.issues.get(
id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "issues",
"action": "get",
"params": {
"id": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Issue ID |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `object` | |
</details>
### Projects
#### Projects List
Returns a paginated list of projects via GraphQL with pagination support
**Python SDK**
```python
linear.projects.list()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "projects",
"action": "list"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `first` | `integer` | No | Number of items to return (max 250) |
| `after` | `string` | No | Cursor to start after (for pagination) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `object` | |
</details>
#### Projects Get
Get a single project by ID via GraphQL
**Python SDK**
```python
linear.projects.get(
id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "projects",
"action": "get",
"params": {
"id": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Project ID |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `object` | |
</details>
### Teams
#### Teams List
Returns a list of teams via GraphQL with pagination support
**Python SDK**
```python
linear.teams.list()
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "list"
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `first` | `integer` | No | Number of items to return (max 250) |
| `after` | `string` | No | Cursor to start after (for pagination) |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `object` | |
</details>
#### Teams Get
Get a single team by ID via GraphQL
**Python SDK**
```python
linear.teams.get(
id="<str>"
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances/{your_connector_instance_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"entity": "teams",
"action": "get",
"params": {
"id": "<str>"
}
}'
```
**Params**
| Parameter Name | Type | Required | Description |
|----------------|------|----------|-------------|
| `id` | `string` | Yes | Team ID |
<details>
<summary><b>Response Schema</b></summary>
**Records**
| Field Name | Type | Description |
|------------|------|-------------|
| `data` | `object` | |
</details>
## Authentication
The Linear connector supports the following authentication methods:
### Authentication
| Field Name | Type | Required | Description |
|------------|------|----------|-------------|
| `api_key` | `str` | Yes | API authentication key |
#### Example
**Python SDK**
```python
LinearConnector(
auth_config=LinearAuthConfig(
api_key="<API authentication key>"
)
)
```
**API**
```bash
curl --location 'https://api.airbyte.ai/api/v1/connectors/instances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
"connector_definition_id": "1c5d8316-ed42-4473-8fbc-2626f03f070c",
"auth_config": {
"api_key": "<API authentication key>"
},
"name": "My Linear Connector"
}'
```

7
docs/ai-agents/connectors/readme.md
View File

@@ -56,6 +56,11 @@ Use Airbyte agent Connectors when you want:
## How to work with agent connectors
Two options exist to work with an agent connector: Model Context Protocol (MCP) and Python SDK.
Two options exist to work with an agent connector: Airbyte's MCP server and Python SDK.
- [Python SDK tutorial](../quickstarts/tutorial-python) (recommended)
- [MCP tutorial](../quickstarts/tutorial-mcp) (experimental)
## All agent connectors
<DocCardList />

26
docs/ai-agents/connectors/salesforce/CHANGELOG.md Normal file
View File

@@ -0,0 +1,26 @@
# Changelog
## [0.1.4] - 2025-12-13
- Updated connector definition (YAML version 1.0.3)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.1.3] - 2025-12-12
- Updated connector definition (YAML version 1.0.3)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.1.2] - 2025-12-12
- Updated connector definition (YAML version 1.0.2)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.1.1] - 2025-12-12
- Updated connector definition (YAML version 1.0.2)
- Source commit: 244fd1c6
- SDK version: 0.1.0
## [0.1.0] - 2025-12-12
- Updated connector definition (YAML version 1.0.1)
- Source commit: e71241ac
- SDK version: 0.1.0

78
docs/ai-agents/connectors/salesforce/README.md Normal file
View File

@@ -0,0 +1,78 @@
# Airbyte Salesforce AI Connector
Salesforce is a cloud-based CRM platform that helps businesses manage customer
relationships, sales pipelines, and business operations. This connector provides
access to accounts, contacts, leads, opportunities, tasks, events, campaigns, cases,
notes, and attachments for sales analytics and customer relationship management.
## Example Questions
- Show me my top 5 opportunities this month
- List all contacts from [Company] in the last quarter
- Search for leads in the technology sector with revenue over $10M
- What trends can you identify in my recent sales pipeline?
- Summarize the open cases for my key accounts
- Find upcoming events related to my most important opportunities
- Analyze the performance of my recent marketing campaigns
- Identify the highest value opportunities I'm currently tracking
- Show me the notes and attachments for [customerX]'s account
## Unsupported Questions
- Create a new lead for [personX]
- Update the status of my sales opportunity
- Schedule a follow-up meeting with [customerX]
- Delete this old contact record
- Send an email to all contacts in this campaign
## Installation
```bash
uv pip install airbyte-ai-salesforce
```
## Usage
```python
from airbyte_ai_salesforce import SalesforceConnector, SalesforceAuthConfig
connector = SalesforceConnector(
auth_config=SalesforceAuthConfig(
refresh_token="...",
client_id="...",
client_secret="..."
)
)
result = connector.accounts.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Accounts | [List](./REFERENCE.md#accounts-list), [Get](./REFERENCE.md#accounts-get), [Search](./REFERENCE.md#accounts-search) |
| Contacts | [List](./REFERENCE.md#contacts-list), [Get](./REFERENCE.md#contacts-get), [Search](./REFERENCE.md#contacts-search) |
| Leads | [List](./REFERENCE.md#leads-list), [Get](./REFERENCE.md#leads-get), [Search](./REFERENCE.md#leads-search) |
| Opportunities | [List](./REFERENCE.md#opportunities-list), [Get](./REFERENCE.md#opportunities-get), [Search](./REFERENCE.md#opportunities-search) |
| Tasks | [List](./REFERENCE.md#tasks-list), [Get](./REFERENCE.md#tasks-get), [Search](./REFERENCE.md#tasks-search) |
| Events | [List](./REFERENCE.md#events-list), [Get](./REFERENCE.md#events-get), [Search](./REFERENCE.md#events-search) |
| Campaigns | [List](./REFERENCE.md#campaigns-list), [Get](./REFERENCE.md#campaigns-get), [Search](./REFERENCE.md#campaigns-search) |
| Cases | [List](./REFERENCE.md#cases-list), [Get](./REFERENCE.md#cases-get), [Search](./REFERENCE.md#cases-search) |
| Notes | [List](./REFERENCE.md#notes-list), [Get](./REFERENCE.md#notes-get), [Search](./REFERENCE.md#notes-search) |
| Content Versions | [List](./REFERENCE.md#content-versions-list), [Get](./REFERENCE.md#content-versions-get), [Download](./REFERENCE.md#content-versions-download) |
| Attachments | [List](./REFERENCE.md#attachments-list), [Get](./REFERENCE.md#attachments-get), [Download](./REFERENCE.md#attachments-download) |
| Query | [List](./REFERENCE.md#query-list) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Salesforce API Reference](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_rest.htm).
## Version Information
**Package Version:** 0.1.4
**Connector Version:** 1.0.3
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

1938
docs/ai-agents/connectors/salesforce/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

199
docs/ai-agents/connectors/stripe/CHANGELOG.md Normal file
View File

@@ -0,0 +1,199 @@
# Changelog
## [0.5.11] - 2025-12-13
- Updated connector definition (YAML version 0.1.2)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.5.10] - 2025-12-12
- Updated connector definition (YAML version 0.1.2)
- Source commit: c17d44a8
- SDK version: 0.1.0
## [0.5.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.5.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.5.7] - 2025-12-12
- Updated connector definition (YAML version 0.1.0)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.5.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.5.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.5.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.5.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.5.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.0)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.5.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.0)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.5.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.4.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.0)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.3.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.2.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.1.23] - 2025-12-05
- Updated connector definition (YAML version 0.0.1)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.1.22] - 2025-12-04
- Updated connector definition (YAML version 0.0.1)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.1.21] - 2025-12-04
- Updated connector definition (YAML version 0.0.1)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.1.20] - 2025-12-04
- Updated connector definition (YAML version 0.0.1)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.1.19] - 2025-12-04
- Updated connector definition (YAML version 0.0.1)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.1.18] - 2025-12-03
- Updated connector definition (YAML version 0.0.1)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.1.17] - 2025-12-03
- Updated connector definition (YAML version 0.0.1)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.1.16] - 2025-12-02
- Updated connector definition (YAML version 0.0.1)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.1.15] - 2025-12-02
- Updated connector definition (YAML version 0.0.1)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.1.14] - 2025-12-02
- Updated connector definition (YAML version 0.0.1)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.1.13] - 2025-12-02
- Updated connector definition (YAML version 0.0.1)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.1.12] - 2025-12-02
- Updated connector definition (YAML version 0.0.4)
- Source commit: 236db7f0
- SDK version: 0.1.0
## [0.1.11] - 2025-12-02
- Updated connector definition (YAML version 0.0.3)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.1.10] - 2025-12-02
- Updated connector definition (YAML version 0.0.3)
- Source commit: cd499acd
- SDK version: 0.1.0
## [0.1.9] - 2025-12-02
- Updated connector definition (YAML version 0.0.3)
- Source commit: 64df6a87
- SDK version: 0.1.0
## [0.1.8] - 2025-12-02
- Updated connector definition (YAML version 0.0.1)
- Source commit: f34b246f
- SDK version: 0.1.0
## [0.1.7] - 2025-12-02
- Updated connector definition (YAML version 0.0.1)
- Source commit: b261c3a2
- SDK version: 0.1.0
## [0.1.6] - 2025-11-27
- Updated connector definition (YAML version 0.0.1)
- Source commit: 702fd446
- SDK version: 0.1.0
## [0.1.5] - 2025-11-27
- Updated connector definition (YAML version 0.0.1)
- Source commit: d656a4a2
- SDK version: 0.1.0
## [0.1.4] - 2025-11-27
- Updated connector definition (YAML version 0.0.1)
- Source commit: 9afac212
- SDK version: 0.1.0
## [0.1.3] - 2025-11-27
- Updated connector definition (YAML version 0.0.1)
- Source commit: 9afac212
- SDK version: 0.1.0
## [0.1.2] - 2025-11-27
- Updated connector definition (YAML version 0.0.1)
- Source commit: c1700e5e
- SDK version: 0.1.0
- YAML version: 0.0.1
## [0.1.1] - 2025-11-26
- Updated connector definition (YAML version 0.0.1)
- Source commit: 5a3bf104
- SDK version: 0.1.0
- YAML version: 0.0.1
## [0.1.0] - 2025-11-26
- Updated connector definition (YAML version 0.0.1)
- Source commit: 5a3bf104
- SDK version: 0.1.0
- YAML version: 0.0.1

75
docs/ai-agents/connectors/stripe/README.md Normal file
View File

@@ -0,0 +1,75 @@
# Airbyte Stripe AI Connector
Stripe is a payment processing platform that enables businesses to accept payments,
manage subscriptions, and handle financial transactions. This connector provides
access to customers for payment analytics and customer management.
## Example Questions
- Show me my top 10 customers by total revenue this month
- List all customers who have spent over $5,000 in the last quarter
- Analyze payment trends for my Stripe customers
- Identify which customers have the most consistent subscription payments
- Give me insights into my customer retention rates
- Summarize the payment history for [customerX]
- Compare customer spending patterns from last month to this month
- Show me details about my highest-value Stripe customers
- What are the key financial insights from my customer base?
- Break down my customers by their average transaction value
## Unsupported Questions
- Create a new customer profile in Stripe
- Update the billing information for [customerX]
- Delete a customer record
- Send a payment reminder to [customerX]
- Schedule an automatic invoice for [Company]
## Installation
```bash
uv pip install airbyte-ai-stripe
```
## Usage
```python
from airbyte_ai_stripe import StripeConnector, StripeAuthConfig
connector = StripeConnector(
auth_config=StripeAuthConfig(
api_key="..."
)
)
result = connector.customers.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Customers | [List](./REFERENCE.md#customers-list), [Get](./REFERENCE.md#customers-get), [Search](./REFERENCE.md#customers-search) |
| Invoices | [List](./REFERENCE.md#invoices-list), [Get](./REFERENCE.md#invoices-get), [Search](./REFERENCE.md#invoices-search) |
| Charges | [List](./REFERENCE.md#charges-list), [Get](./REFERENCE.md#charges-get), [Search](./REFERENCE.md#charges-search) |
| Subscriptions | [List](./REFERENCE.md#subscriptions-list), [Get](./REFERENCE.md#subscriptions-get), [Search](./REFERENCE.md#subscriptions-search) |
| Refunds | [List](./REFERENCE.md#refunds-list), [Get](./REFERENCE.md#refunds-get) |
| Products | [List](./REFERENCE.md#products-list), [Get](./REFERENCE.md#products-get), [Search](./REFERENCE.md#products-search) |
| Balance | [Get](./REFERENCE.md#balance-get) |
| Balance Transactions | [List](./REFERENCE.md#balance-transactions-list), [Get](./REFERENCE.md#balance-transactions-get) |
| Payment Intents | [List](./REFERENCE.md#payment-intents-list), [Get](./REFERENCE.md#payment-intents-get), [Search](./REFERENCE.md#payment-intents-search) |
| Disputes | [List](./REFERENCE.md#disputes-list), [Get](./REFERENCE.md#disputes-get) |
| Payouts | [List](./REFERENCE.md#payouts-list), [Get](./REFERENCE.md#payouts-get) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Stripe API Reference](https://docs.stripe.com/api).
## Version Information
**Package Version:** 0.5.11
**Connector Version:** 0.1.2
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

2434
docs/ai-agents/connectors/stripe/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

146
docs/ai-agents/connectors/zendesk-support/CHANGELOG.md Normal file
View File

@@ -0,0 +1,146 @@
# Changelog
## [0.18.11] - 2025-12-13
- Updated connector definition (YAML version 0.1.3)
- Source commit: 1ab72bd8
- SDK version: 0.1.0
## [0.18.10] - 2025-12-12
- Updated connector definition (YAML version 0.1.3)
- Source commit: 4d366cb5
- SDK version: 0.1.0
## [0.18.9] - 2025-12-12
- Updated connector definition (YAML version 0.1.2)
- Source commit: 89d7172b
- SDK version: 0.1.0
## [0.18.8] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: dc79dc8b
- SDK version: 0.1.0
## [0.18.7] - 2025-12-12
- Updated connector definition (YAML version 0.1.1)
- Source commit: 9f7f8a98
- SDK version: 0.1.0
## [0.18.6] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 8c06aa10
- SDK version: 0.1.0
## [0.18.5] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 11427ac3
- SDK version: 0.1.0
## [0.18.4] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: bdd5df6d
- SDK version: 0.1.0
## [0.18.3] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: f2497f71
- SDK version: 0.1.0
## [0.18.2] - 2025-12-11
- Updated connector definition (YAML version 0.1.1)
- Source commit: 7d738be5
- SDK version: 0.1.0
## [0.18.1] - 2025-12-10
- Updated connector definition (YAML version 0.1.1)
- Source commit: 76636830
- SDK version: 0.1.0
## [0.18.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.1)
- Source commit: f2ad5029
- SDK version: 0.1.0
## [0.17.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.1)
- Source commit: 139b0b0d
- SDK version: 0.1.0
## [0.16.0] - 2025-12-08
- Updated connector definition (YAML version 0.1.1)
- Source commit: 60b6c91f
- SDK version: 0.1.0
## [0.15.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: e96bed3d
- SDK version: 0.1.0
## [0.14.0] - 2025-12-05
- Updated connector definition (YAML version 0.1.0)
- Source commit: ed697b90
- SDK version: 0.1.0
## [0.13.0] - 2025-12-05
- Updated connector definition (YAML version 1.0.0)
- Source commit: 20618410
- SDK version: 0.1.0
## [0.12.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4a01e446
- SDK version: 0.1.0
## [0.11.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: 5ec76dde
- SDK version: 0.1.0
## [0.10.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: df32a458
- SDK version: 0.1.0
## [0.9.0] - 2025-12-04
- Updated connector definition (YAML version 1.0.0)
- Source commit: a506b369
- SDK version: 0.1.0
## [0.8.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 92a39ab5
- SDK version: 0.1.0
## [0.7.0] - 2025-12-03
- Updated connector definition (YAML version 1.0.0)
- Source commit: 0ce38253
- SDK version: 0.1.0
## [0.6.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: c8e326d9
- SDK version: 0.1.0
## [0.5.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: ad0b961b
- SDK version: 0.1.0
## [0.4.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 7153780a
- SDK version: 0.1.0
## [0.3.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 01f71cad
- SDK version: 0.1.0
## [0.2.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: 4c17f060
- SDK version: 0.1.0
## [0.1.0] - 2025-12-02
- Updated connector definition (YAML version 1.0.0)
- Source commit: cd499acd
- SDK version: 0.1.0

87
docs/ai-agents/connectors/zendesk-support/README.md Normal file
View File

@@ -0,0 +1,87 @@
# Airbyte Zendesk-Support AI Connector
Zendesk Support is a customer service platform that helps businesses manage support
tickets, customer interactions, and help center content. This connector provides
access to tickets, users, organizations, groups, comments, attachments, automations,
triggers, macros, views, satisfaction ratings, SLA policies, and help center articles
for customer support analytics and service performance insights.
## Example Questions
- Show me the tickets assigned to me last week
- What are the top 5 support issues our organization has faced this month?
- List all unresolved tickets for [customerX]
- Analyze the satisfaction ratings for our support team in the last 30 days
- Compare ticket resolution times across different support groups
- Show me the details of recent tickets tagged with [specific tag]
- Identify the most common ticket fields used in our support workflow
- Summarize the performance of our SLA policies this quarter
## Unsupported Questions
- Create a new support ticket for [customerX]
- Update the priority of this ticket
- Assign this ticket to [teamMember]
- Delete these old support tickets
- Send an automatic response to [customerX]
## Installation
```bash
uv pip install airbyte-ai-zendesk-support
```
## Usage
```python
from airbyte_ai_zendesk_support import ZendeskSupportConnector, ZendeskSupportAuthConfig
connector = ZendeskSupportConnector(
auth_config=ZendeskSupportAuthConfig(
access_token="...",
refresh_token="..."
)
)
result = connector.tickets.list()
```
## Documentation
| Entity | Actions |
|--------|---------|
| Tickets | [List](./REFERENCE.md#tickets-list), [Get](./REFERENCE.md#tickets-get) |
| Users | [List](./REFERENCE.md#users-list), [Get](./REFERENCE.md#users-get) |
| Organizations | [List](./REFERENCE.md#organizations-list), [Get](./REFERENCE.md#organizations-get) |
| Groups | [List](./REFERENCE.md#groups-list), [Get](./REFERENCE.md#groups-get) |
| Ticket Comments | [List](./REFERENCE.md#ticket-comments-list) |
| Attachments | [Get](./REFERENCE.md#attachments-get), [Download](./REFERENCE.md#attachments-download) |
| Ticket Audits | [List](./REFERENCE.md#ticket-audits-list), [List](./REFERENCE.md#ticket-audits-list) |
| Ticket Metrics | [List](./REFERENCE.md#ticket-metrics-list) |
| Ticket Fields | [List](./REFERENCE.md#ticket-fields-list), [Get](./REFERENCE.md#ticket-fields-get) |
| Brands | [List](./REFERENCE.md#brands-list), [Get](./REFERENCE.md#brands-get) |
| Views | [List](./REFERENCE.md#views-list), [Get](./REFERENCE.md#views-get) |
| Macros | [List](./REFERENCE.md#macros-list), [Get](./REFERENCE.md#macros-get) |
| Triggers | [List](./REFERENCE.md#triggers-list), [Get](./REFERENCE.md#triggers-get) |
| Automations | [List](./REFERENCE.md#automations-list), [Get](./REFERENCE.md#automations-get) |
| Tags | [List](./REFERENCE.md#tags-list) |
| Satisfaction Ratings | [List](./REFERENCE.md#satisfaction-ratings-list), [Get](./REFERENCE.md#satisfaction-ratings-get) |
| Group Memberships | [List](./REFERENCE.md#group-memberships-list) |
| Organization Memberships | [List](./REFERENCE.md#organization-memberships-list) |
| Sla Policies | [List](./REFERENCE.md#sla-policies-list), [Get](./REFERENCE.md#sla-policies-get) |
| Ticket Forms | [List](./REFERENCE.md#ticket-forms-list), [Get](./REFERENCE.md#ticket-forms-get) |
| Articles | [List](./REFERENCE.md#articles-list), [Get](./REFERENCE.md#articles-get) |
| Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
For detailed documentation on available actions and parameters, see [REFERENCE.md](./REFERENCE.md).
For the service's official API docs, see [Zendesk-Support API Reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
## Version Information
**Package Version:** 0.18.11
**Connector Version:** 0.1.3
**Generated with connector-sdk:** 1ab72bd8e7249872a4cf66327dd1a0bf68905acb

2689
docs/ai-agents/connectors/zendesk-support/REFERENCE.md Normal file
View File

File diff suppressed because it is too large Load Diff

11
docs/ai-agents/quickstarts/readme.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
import DocCardList from '@theme/DocCardList';
# Agent connectors quickstarts
These tutorials get you started using Airbyte's [agent connectors](../connectors).
<DocCardList />

9
docs/ai-agents/connectors/tutorial-mcp.md → docs/ai-agents/quickstarts/tutorial-mcp.md
View File

@@ -1,15 +1,20 @@
---
sidebar_label: "Connector MCP tutorial"
sidebar_position: 2
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get started with agent connectors: Connector MCP
# Agent connector tutorial: Connector MCP
In this tutorial, you'll install and run Airbyte's connector MCP server locally, connect the MCP server to Claude Code or your preferred agent, and learn to use natural language to explore your data. This tutorial uses Stripe, but if you don't have a Stripe account, you can use one of Airbyte's other agent connectors.
The MCP server is quick and easy to set up, but it affords less control over how you use agent connectors compared to the Python SDK. Data goes directly from the API to your AI agent.
:::warning
The Connector MCP server is experimental. It's quick and easy to set up, but it affords less control over how you use agent connectors compared to the Python SDK. Data goes directly from the API to your AI agent.
Feel free to try the MCP server, but it's better to use the [Python SDK](tutorial-python) to build a more robust agent.
:::
## Overview

11
docs/ai-agents/connectors/tutorial-python.md → docs/ai-agents/quickstarts/tutorial-python.md
View File

@@ -1,10 +1,11 @@
---
sidebar_label: "Python SDK tutorial"
sidebar_position: 1
---
# Get started with agent connectors: Python SDK
# Agent connector tutorial: Python&nbsp;SDK
In this tutorial, you'll create a new Python project with `uv`, add a Pydantic AI agent, equip it to use one of Airbyte's agent connectors, and use natural language to explore your data. This tutorial uses GitHub, but if you don't have a GitHub account, you can use one of Airbyte's other agent connectors and perform different operations.
In this tutorial, you'll create a new Python project with uv, add a Pydantic AI agent, equip it to use one of Airbyte's agent connectors, and use natural language to explore your data. This tutorial uses GitHub, but if you don't have a GitHub account, you can use one of Airbyte's other agent connectors and perform different operations.
Using the Python SDK is more time-consuming than the Connector MCP server, but affords you the most control over the context you send to your agent.
@@ -134,7 +135,7 @@ connector = GithubConnector(
)
```
### Create the agent
### Define the agent
Create a Pydantic AI agent with a system prompt that describes its purpose:
@@ -228,14 +229,14 @@ The agent has basic message history within each session, and you can ask followu
If your agent fails to retrieve GitHub data, check the following:
- **HTTP 401 errors**: Your `GITHUB_ACCESS_TOKEN` is invalid or expired. Generate a new token and update your `.env` file.
- **HTTP 403 errors**: Your token doesn't have the required scopes. Ensure your token has `repo` scope for accessing repository data.
- **HTTP 403 errors**: Your `GITHUB_ACCESS_TOKEN` doesn't have the required scopes. Ensure your token has `repo` scope for accessing repository data.
- **OpenAI errors**: Verify your `OPENAI_API_KEY` is valid, has available credits, and won't exceed rate limits.
## Summary
In this tutorial, you learned how to:
- Set up a new Python project with `uv`
- Set up a new Python project with uv
- Add Pydantic AI and Airbyte's GitHub agent connector to your project
- Configure environment variables and authentication
- Add tools to your agent using the GitHub connector

5
docs/platform/readme.md
View File

@@ -2,7 +2,7 @@
products: all
---
# Data replication platform
# Platform
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
@@ -46,7 +46,6 @@ Data replication _isn't_ ideal when you:
- Are working with a small amount of data
- Need to trigger side effects, like sending an email or closing a ticket
If data replication isn't what you're looking for, [Agent engine](/ai-agents) might be.
### Taxonomy of data movement
@@ -78,7 +77,7 @@ Airbyte's data replication platform is available as a self-managed, hybrid, or f
<CardWithIcon title="Pro" description="A cloud solution for organizations looking to scale efficiently. Role based access control, single sign on, and more ensure Pro is a robust solution that can grow with your team." ctaText="Talk to Sales" ctaLink="https://airbyte.com/company/talk-to-sales" icon="fa-lock" />
<CardWithIcon title="Enterprise Flex" description="An enterprise-grade, hybrid solution with for organizatons seeking the convenience of a fully managed solution with separate data planes for compliance and data sovereignty." ctaText="Learn more" ctaLink="enterprise-flex" icon="fa-lock" />
<CardWithIcon title="Enterprise Flex" description="An enterprise-grade, hybrid solution for organizations seeking the convenience of a fully managed solution with separate data planes for compliance and data sovereignty." ctaText="Learn more" ctaLink="enterprise-flex" icon="fa-lock" />
</Grid>

2
docusaurus/docusaurus.config.ts
View File

@@ -395,7 +395,7 @@ const config: Config = {
position: "left",
docsPluginId: "platform",
sidebarId: "platform",
label: "Data replication",
label: "Platform",
},
{
type: "docSidebar",

7
docusaurus/src/pages/index.js
View File

@@ -85,7 +85,7 @@ export default function Home() {
const navLinks = [
{
title: 'Data replication platform',
title: 'Platform',
link: '/platform/',
description: 'Use Airbyte\'s data replication platform to create connections, build custom connectors, and start syncing data in minutes.',
icon: PlatformIcon,
@@ -103,9 +103,9 @@ export default function Home() {
icon: ReleaseNotesIcon,
},
{
title: 'Agent engine',
title: 'AI agents',
link: '/ai-agents/',
description: 'Use Airbyte\'s Agent engine to build intelligent data pipelines, explore your data, and work with it with help from AI.',
description: 'Equip your AI agents to explore and work with your data.',
icon: AIAgentsIcon,
},
{
@@ -137,7 +137,6 @@ export default function Home() {
Airbyte is an open source data integration, activation, and agentic data platform.
Use our data replication platform to consolidate data from hundreds of sources into your data warehouses, data lakes, and databases.
Then, move data into the operational tools where work happens, like CRMs, marketing platforms, and support systems.
Or, use our Agent engine to ask questions, explore, and update your data with AI agents.
</p>
</div>
<div className={styles.heroRight}>