# Table of Contents - [Search the documentation | Airbyte Docs](#search-the-documentation-airbyte-docs) - [Agent Engine | Airbyte Docs](#agent-engine-airbyte-docs) - [About Agent Engine | Airbyte Docs](#about-agent-engine-airbyte-docs) - [Airbyte Docs](#airbyte-docs) - [Agent engine API | Airbyte Docs](#agent-engine-api-airbyte-docs) - [Agent Engine API | Airbyte Docs](#agent-engine-api-airbyte-docs) - [Authentication | Airbyte Docs](#authentication-airbyte-docs) - [Authentication (Advanced) | Airbyte Docs](#authentication-advanced-airbyte-docs) - [Connectors | Airbyte Docs](#connectors-airbyte-docs) - [Connectors (Advanced) | Airbyte Docs](#connectors-advanced-airbyte-docs) - [Create Scoped Token | Airbyte Docs](#create-scoped-token-airbyte-docs) - [Generate Application Token | Airbyte Docs](#generate-application-token-airbyte-docs) - [Create Widget Token | Airbyte Docs](#create-widget-token-airbyte-docs) - [Create a connector | Airbyte Docs](#create-a-connector-airbyte-docs) - [Check config when creating a connector | Airbyte Docs](#check-config-when-creating-a-connector-airbyte-docs) - [Execute actions | Airbyte Docs](#execute-actions-airbyte-docs) - [Delete a connector | Airbyte Docs](#delete-a-connector-airbyte-docs) - [Delete connector OAuth | Airbyte Docs](#delete-connector-oauth-airbyte-docs) - [Describe Cron Expression | Airbyte Docs](#describe-cron-expression-airbyte-docs) - [Create Connection Template | Airbyte Docs](#create-connection-template-airbyte-docs) - [Check config when updating a connector | Airbyte Docs](#check-config-when-updating-a-connector-airbyte-docs) - [Enable a connector | Airbyte Docs](#enable-a-connector-airbyte-docs) - [Data replication | Airbyte Docs](#data-replication-airbyte-docs) - [Delete Connection Template | Airbyte Docs](#delete-connection-template-airbyte-docs) - [Disable a connector | Airbyte Docs](#disable-a-connector-airbyte-docs) - [Delete Workspace | Airbyte Docs](#delete-workspace-airbyte-docs) - [Get Scoped Token Info | Airbyte Docs](#get-scoped-token-info-airbyte-docs) - [Get a connector | Airbyte Docs](#get-a-connector-airbyte-docs) - [Get Destination Definition | Airbyte Docs](#get-destination-definition-airbyte-docs) - [Get Workspace Stats | Airbyte Docs](#get-workspace-stats-airbyte-docs) - [Get Connection Template | Airbyte Docs](#get-connection-template-airbyte-docs) - [Get Workspace | Airbyte Docs](#get-workspace-airbyte-docs) - [Get a connector definition | Airbyte Docs](#get-a-connector-definition-airbyte-docs) - [List connectors | Airbyte Docs](#list-connectors-airbyte-docs) - [List Workspaces | Airbyte Docs](#list-workspaces-airbyte-docs) - [Get an enabled connector | Airbyte Docs](#get-an-enabled-connector-airbyte-docs) - [Configure connector OAuth | Airbyte Docs](#configure-connector-oauth-airbyte-docs) - [List connector definitions | Airbyte Docs](#list-connector-definitions-airbyte-docs) - [List Destination Definitions | Airbyte Docs](#list-destination-definitions-airbyte-docs) - [List Connection Templates | Airbyte Docs](#list-connection-templates-airbyte-docs) - [Update a connector | Airbyte Docs](#update-a-connector-airbyte-docs) - [Update Workspace | Airbyte Docs](#update-workspace-airbyte-docs) - [List enabled connectors | Airbyte Docs](#list-enabled-connectors-airbyte-docs) - [Workspaces | Airbyte Docs](#workspaces-airbyte-docs) - [Patch Connection Template | Airbyte Docs](#patch-connection-template-airbyte-docs) - [Update an enabled connector | Airbyte Docs](#update-an-enabled-connector-airbyte-docs) --- # Search the documentation | Airbyte Docs Opens in a new window Opens an external website Opens an external website in a new window This website utilizes technologies such as cookies to enable essential site functionality, as well as for analytics, personalization, and targeted advertising. By clicking ‘Accept,’ you understand your information may be disclosed to our third-party partners. [Privacy Policy](https://airbyte.com/company/privacy-policy) Accept Deny Non-Essential Close Cookie Preferences [Skip to main content](https://docs.airbyte.com/search#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Search the documentation ======================== Search by Algolia[](https://www.algolia.com/) --- # Agent Engine | Airbyte Docs Opens in a new window Opens an external website Opens an external website in a new window This website utilizes technologies such as cookies to enable essential site functionality, as well as for analytics, personalization, and targeted advertising. By clicking ‘Accept,’ you understand your information may be disclosed to our third-party partners. [Privacy Policy](https://airbyte.com/company/privacy-policy) Accept Deny Non-Essential Close Cookie Preferences [Skip to main content](https://docs.airbyte.com/ai-agents/#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Airbyte's Agent Engine is a data layer for AI agents. Use the Agent Engine as a cloud platform to manage connectors, credentials, and data replication for your agents. You can also use Airbyte's open source agent connectors as standalone Python packages, import them into your AI agents, and manage storage and credentials yourself. New and growing The Agent engine is new and growing. Airbyte is actively seeking feedback. Expect this platform and its library of connectors to grow and change rapidly. About Agent Engine ------------------ Learn what the Agent Engine does, who its for, and how you can use it. About Tutorials --------- Get started with the Agent Engine and its connectors. Even if you've never built an AI agent before, you can have one working for you in 15 minutes or less. Tutorials Platform -------- Use Airbyte's Agent Engine to store and manage credentials, run connectors, and power agentic search. Platform docs API docs -------- Use our API to set up connectors, authentication, execute operations, and manage workspaces. API docs Connectors ---------- Browse our catalog of connectors, copy code samples, and start powering your agents. Connectors --- # About Agent Engine | Airbyte Docs Opens in a new window Opens an external website Opens an external website in a new window This website utilizes technologies such as cookies to enable essential site functionality, as well as for analytics, personalization, and targeted advertising. By clicking ‘Accept,’ you understand your information may be disclosed to our third-party partners. [Privacy Policy](https://airbyte.com/company/privacy-policy) Accept Deny Non-Essential Close Cookie Preferences [Skip to main content](https://docs.airbyte.com/ai-agents/about/#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. On this page Airbyte's Agent Engine is a data layer for AI agents. Use the Agent Engine as a cloud platform to manage connectors, credentials, and data replication for your agents. You can also use Airbyte's open source agent connectors as standalone Python packages, import them into your AI agents, and manage storage and credentials yourself. The problem with AI agents[​](https://docs.airbyte.com/ai-agents/about/#the-problem-with-ai-agents "Direct link to The problem with AI agents") ------------------------------------------------------------------------------------------------------------------------------------------------ AI agents have almost unlimited potential to scale productivity, accelerate insights, and democratize information. However, most organizations struggle to realize this promise. * Large language models can reason, but rely on stale public training data that limits their effectiveness. They lack real-time knowledge, are stateless, and can't act on and verify facts. * Improving context with real business data is difficult. It forces teams to build infrastructure they don't want to own: storage layers, indexing services, pipelines, and permissions models. All of this is maintenance debt just to acquire missing context. * Even if high-quality data is available, agents still perform poorly. They lack real-time access, can't search, can't write, miss key information, and need human intervention. Organizations trying to build agents face a problem: * They need massive upfront investment, or * Their agents don't perform well, or * Both The result is that agentic features never scale. They remain expensive, fragile prototypes that can't support real-world operations. How Airbyte solves that problem[​](https://docs.airbyte.com/ai-agents/about/#how-airbyte-solves-that-problem "Direct link to How Airbyte solves that problem") --------------------------------------------------------------------------------------------------------------------------------------------------------------- Airbyte's Agent Engine solves this problem with three components. * Open-source, type-safe connectors designed for AI agents. These connectors allow agents to retrieve information they don't have, perform computations or transformations, interact with external systems, and trigger side-effects, like sending emails, updating databases, and starting workflows * Storage and management of end-user credentials. * Out of the box entity caching to power low-latency search operations. It's helpful to think of the Agent Engine as a data layer that makes agentic tool use easy. Tools are external capabilities AI agents can invoke. They allow agents to perceive, decide, and act beyond their training data. They're one of the most critical bridges between agents that aren't effective and agents with broad capabilities. Who Agent Engine is for[​](https://docs.airbyte.com/ai-agents/about/#who-agent-engine-is-for "Direct link to Who Agent Engine is for") --------------------------------------------------------------------------------------------------------------------------------------- * AI companies building agentic solutions, especially multi-tenant SaaS services. * Engineering teams building agents for internal use cases. * Hackers, explorers, innovators, and anyone who needs to empower an agent in minutes. * People tired of expensive agents that aren't helpful. Tools and MCP servers[​](https://docs.airbyte.com/ai-agents/about/#tools-and-mcp-servers "Direct link to Tools and MCP servers") --------------------------------------------------------------------------------------------------------------------------------- It's helpful to think of agent connectors as equivalent to sets of tools. Tools are external capabilities AI agents can invoke. They allow agents to perceive, decide, and act beyond their training data. Tools are one of the most critical bridges between agents that aren't effective and agents with broad capabilities. * [The problem with AI agents](https://docs.airbyte.com/ai-agents/about/#the-problem-with-ai-agents) * [How Airbyte solves that problem](https://docs.airbyte.com/ai-agents/about/#how-airbyte-solves-that-problem) * [Who Agent Engine is for](https://docs.airbyte.com/ai-agents/about/#who-agent-engine-is-for) * [Tools and MCP servers](https://docs.airbyte.com/ai-agents/about/#tools-and-mcp-servers) Was this page helpful? YesNo --- # Airbyte Docs Opens in a new window Opens an external website Opens an external website in a new window This website utilizes technologies such as cookies to enable essential site functionality, as well as for analytics, personalization, and targeted advertising. By clicking ‘Accept,’ you understand your information may be disclosed to our third-party partners. [Privacy Policy](https://airbyte.com/company/privacy-policy) Accept Deny Non-Essential Close Cookie Preferences [Skip to main content](https://docs.airbyte.com/#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Airbyte documentation ===================== Airbyte is an open source data integration, activation, and agentic data platform. Replicate data from hundreds of sources into warehouses, lakes, and databases, and equip AI agents to query, search, and act on your data in real-time. Data Replication ---------------- Consolidate data from hundreds of sources into your data warehouses, data lakes, and databases. Then, move data into the operational tools where work happens. ### Popular sources [![Postgres](https://connectors.airbyte.com/files/metadata/airbyte/source-postgres/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/postgres "Postgres") [![Facebook Marketing](https://connectors.airbyte.com/files/metadata/airbyte/source-facebook-marketing/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/facebook-marketing "Facebook Marketing") [![Salesforce](https://connectors.airbyte.com/files/metadata/airbyte/source-salesforce/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/salesforce "Salesforce") [![MySQL](https://connectors.airbyte.com/files/metadata/airbyte/source-mysql/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/mysql "MySQL") [![Google Sheets](https://connectors.airbyte.com/files/metadata/airbyte/source-google-sheets/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/google-sheets "Google Sheets") [![LinkedIn Ads](https://connectors.airbyte.com/files/metadata/airbyte/source-linkedin-ads/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/linkedin-ads "LinkedIn Ads") [![MSSQL](https://connectors.airbyte.com/files/metadata/airbyte/source-mssql/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/mssql "MSSQL") [![S3](https://connectors.airbyte.com/files/metadata/airbyte/source-s3/latest/icon.svg)](https://docs.airbyte.com/integrations/sources/s3 "S3") ### Popular destinations [![S3](https://connectors.airbyte.com/files/metadata/airbyte/destination-s3/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/s3 "S3") [![Postgres](https://connectors.airbyte.com/files/metadata/airbyte/destination-postgres/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/postgres "Postgres") [![Snowflake](https://connectors.airbyte.com/files/metadata/airbyte/destination-snowflake/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/snowflake "Snowflake") [![BigQuery](https://connectors.airbyte.com/files/metadata/airbyte/destination-bigquery/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/bigquery "BigQuery") [![Databricks](https://connectors.airbyte.com/files/metadata/airbyte/destination-databricks/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/databricks "Databricks") [![S3 Data Lake](https://connectors.airbyte.com/files/metadata/airbyte/destination-s3-data-lake/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/s3-data-lake "S3 Data Lake") [![ClickHouse](https://connectors.airbyte.com/files/metadata/airbyte/destination-clickhouse/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/clickhouse "ClickHouse") [![MSSQL](https://connectors.airbyte.com/files/metadata/airbyte/destination-mssql/latest/icon.svg)](https://docs.airbyte.com/integrations/destinations/mssql "MSSQL") [### Platform\ \ Create connections, build custom connectors, and start syncing data in minutes.](https://docs.airbyte.com/platform/) [### Connectors\ \ Browse over 600 sources and destinations, and learn to set them up.](https://docs.airbyte.com/integrations/) [### Release notes\ \ See what's new. Self-Managed versions release regularly. Cloud customers always have the latest.](https://docs.airbyte.com/release_notes/) [### Developers\ \ Interact with Airbyte programmatically using our API, Terraform provider, and more.](https://docs.airbyte.com/developers) [### Community\ \ Get help using, and contribute to, Airbyte.](https://docs.airbyte.com/community) Agent Engine ------------ Equip your AI agents to explore, query, and act on live data from any connected source. [### About Agent Engine\ \ Learn what Agent Engine is, how it works, and who it's for.](https://docs.airbyte.com/ai-agents/about/) [### Tutorials\ \ Step-by-step guides and quickstarts to get your agents up and running.](https://docs.airbyte.com/ai-agents/tutorials/) [### Platform\ \ Authenticate, configure connectors, manage context stores, and execute agent workflows.](https://docs.airbyte.com/ai-agents/platform/) [### API reference\ \ Integrate Agent Engine into your applications with the REST API.](https://docs.airbyte.com/ai-agents/api/) [### Connectors\ \ Browse the growing catalog of agent-optimized connectors for popular platforms.](https://docs.airbyte.com/ai-agents/connectors/) [### MCP server\ \ Let AI agents interact with your data sources through the Model Context Protocol.](https://docs.airbyte.com/ai-agents/mcp-server/) [![GitHub stars](https://img.shields.io/github/stars/airbytehq/airbyte?style=social&label=Star)](https://github.com/airbytehq/airbyte/stargazers/) [![MIT License](https://img.shields.io/static/v1?label=license&message=MIT&color=brightgreen)](https://docs.airbyte.com/community/licenses/mit-license) [![ELv2 License](https://img.shields.io/static/v1?label=license&message=ELv2&color=brightgreen)](https://docs.airbyte.com/community/licenses/elv2-license) --- # Agent engine API | Airbyte Docs Opens in a new window Opens an external website Opens an external website in a new window This website utilizes technologies such as cookies to enable essential site functionality, as well as for analytics, personalization, and targeted advertising. By clicking ‘Accept,’ you understand your information may be disclosed to our third-party partners. [Privacy Policy](https://airbyte.com/company/privacy-policy) Accept Deny Non-Essential Close Cookie Preferences [Skip to main content](https://docs.airbyte.com/ai-agents/api/#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. On this page The Agent Engine API lets you manage connectors, credentials, and data operations programmatically. Use it to integrate Airbyte's agent connectors into any language or framework, or to build custom backend services that interact with your end-users' data sources. All API requests use the base URL `https://api.airbyte.ai`. If your account belongs to multiple organizations, include the `X-Organization-Id` header in every request to specify which organization you're targeting. If you belong to a single organization, this header is optional. Token types[​](https://docs.airbyte.com/ai-agents/api/#token-types "Direct link to Token types") ------------------------------------------------------------------------------------------------- The Agent Engine uses a hierarchical token system. Each token type has a different scope and is designed for specific use cases. | Token type | Use case | Scope | | --- | --- | --- | | Application Token | Organization management, generating scoped and widget tokens, executing connector operations | Organization-wide | | Scoped Token | Company-level administration | Single workspace | | Widget Token | Embedding the authentication module in your app | Single workspace with CORS protection | ### Application token[​](https://docs.airbyte.com/ai-agents/api/#application-token "Direct link to Application token") The application token provides organization-level access. Use it for administrative operations like managing connectors, listing workspaces, and generating other tokens lower in the hierarchy. Most API endpoints require an application token. To obtain an application token, send your app credentials to the token endpoint. Find your credentials in the Agent Engine under **Authentication Module** > **Installation**. Request curl -X POST https://api.airbyte.ai/api/v1/account/applications/token \ -H 'Content-Type: application/json' \ -d '{ "client_id": "", "client_secret": "" }' The response contains your application token: Response { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "token_type": "bearer", "expires_in": 900, "organization_id": "12345678-1234-1234-1234-123456789012"} application tokens expire after 15 minutes. Request a new token when needed. ### Scoped token[​](https://docs.airbyte.com/ai-agents/api/#scoped-token "Direct link to Scoped token") Scoped tokens provide workspace-level access for some end-user operations. Each scoped token is limited to a single workspace, ensuring data isolation between workspaces. Generate a scoped token using your application token: Request curl -X POST https://api.airbyte.ai/api/v1/account/applications/scoped-token \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "workspace_name": "workspace_123" }' If the workspace doesn't exist, Airbyte creates it automatically. Scoped tokens expire after 20 minutes. ### Widget token[​](https://docs.airbyte.com/ai-agents/api/#widget-token "Direct link to Widget token") Widget tokens are specialized tokens for embedding the [authentication module](https://docs.airbyte.com/ai-agents/platform/authenticate/build-auth/authentication-module) in your app. They include all features of scoped tokens plus origin validation for CORS protection. Request curl -X POST https://api.airbyte.ai/api/v1/account/applications/widget-token \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ "workspace_name": "workspace_123", "allowed_origin": "https://yourapp.com" }' For more details on widget tokens and template filtering, see the [authentication module](https://docs.airbyte.com/ai-agents/platform/authenticate/build-auth/authentication-module) documentation. ### Security considerations[​](https://docs.airbyte.com/ai-agents/api/#security-considerations "Direct link to Security considerations") * **Never expose tokens in client-side code.** These tokens provide organization-wide access and should only be used in your backend. * **Handle token expiration.** Application tokens expire after 15 minutes and scoped tokens expire after 20 minutes. The Python SDK handles token refresh automatically, but API users must request new tokens when the current token expires. * **Validate the `allowed_origin`** when using widget tokens to ensure requests only come from your app. Make your first request[​](https://docs.airbyte.com/ai-agents/api/#make-your-first-request "Direct link to Make your first request") ------------------------------------------------------------------------------------------------------------------------------------- After you obtain an application token, you can make your first API call. A good starting point is to list the available source connector definitions. This read-only endpoint returns the catalog of connectors available in Agent Engine, so it returns data even if you haven't configured anything yet. Request curl https://api.airbyte.ai/api/v1/integrations/definitions/sources \ -H 'Authorization: Bearer ' The response contains a list of available source connectors: Response { "definitions": [ { "sourceDefinitionId": "acd81c8-0aeb-4e29-955d-a4a25d550401", "name": "GitHub", "iconUrl": "https://connectors.airbyte.com/files/metadata/airbyte/source-github/latest/icon.svg", "supportLevel": "certified" }, { "sourceDefinitionId": "b117307c-14b6-41aa-9571-75e6871e6d44", "name": "Salesforce", "iconUrl": "https://connectors.airbyte.com/files/metadata/airbyte/source-salesforce/latest/icon.svg", "supportLevel": "certified" } ]} You can filter results by name using the `name` query parameter: Request curl 'https://api.airbyte.ai/api/v1/integrations/definitions/sources?name=github' \ -H 'Authorization: Bearer ' Full API reference[​](https://docs.airbyte.com/ai-agents/api/#full-api-reference "Direct link to Full API reference") ---------------------------------------------------------------------------------------------------------------------- For the complete list of endpoints, request and response schemas, and authentication requirements, see the Agent Engine API reference in the sidebar. * [Token types](https://docs.airbyte.com/ai-agents/api/#token-types) * [Application token](https://docs.airbyte.com/ai-agents/api/#application-token) * [Scoped token](https://docs.airbyte.com/ai-agents/api/#scoped-token) * [Widget token](https://docs.airbyte.com/ai-agents/api/#widget-token) * [Security considerations](https://docs.airbyte.com/ai-agents/api/#security-considerations) * [Make your first request](https://docs.airbyte.com/ai-agents/api/#make-your-first-request) * [Full API reference](https://docs.airbyte.com/ai-agents/api/#full-api-reference) Was this page helpful? YesNo --- # Agent Engine API | Airbyte Docs Opens in a new window Opens an external website Opens an external website in a new window This website utilizes technologies such as cookies to enable essential site functionality, as well as for analytics, personalization, and targeted advertising. By clicking ‘Accept,’ you understand your information may be disclosed to our third-party partners. [Privacy Policy](https://airbyte.com/company/privacy-policy) Accept Deny Non-Essential Close Cookie Preferences [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/agent-engine-api#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Version: 0.9.0 Agent Engine API ================ ![](https://cdn.prod.website-files.com/605e01bc25f7e19a82e74788/6335a39da8c96ba75520b156_Logo.svg) This is the public API documentation for Airbyte's Agent Engine. Use the API to manage authentication, connectors, and workspaces, and power their agentic workflows. If you are a member of multiple Agent Engine organizations, add the `X-Organization-Id: organization's UUID` header to your requests. It specifies which organization you are making requests to. If you only belong to one organization, you don't need to set this header. The API contains several types of endpoints. * Authentication: Generate tokens to make other API requests. * Connectors: Create and manage end-user connectors, and execute operations with connectors. * Workspaces: manage workspaces and retrieve workspace statistics. * Data replication: configure connection templates and destination definitions for data replication use cases. Some endpoints are separated into Advanced categories. These endpoints are more specialized and should not be required for day-to-day use of the API. Authentication[​](https://docs.airbyte.com/ai-agents/api/api-reference/agent-engine-api#authentication "Direct link to Authentication") ---------------------------------------------------------------------------------------------------------------------------------------- * HTTP: Bearer Auth | | | | --- | --- | | Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | --- # Authentication | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/authentication#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Generate tokens and configure OAuth credentials for API access. [📄️ Create Scoped Token\ -----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-scoped-token) [📄️ Get Scoped Token Info\ -------------------------\ \ \*\*Requires a Scoped Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/get-account-applications-scoped-token-info) [📄️ Generate Application Token\ ------------------------------\ \ Generate an application access token using client credentials. This endpoint is intentionally unauthenticated - authentication is performed via client\_id and client\_secret in the request body. Returns a self-signed JWT token that can be used for all API calls.](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-token) [📄️ Create Widget Token\ -----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-widget-token) --- # Authentication (Advanced) | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/authentication-advanced#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Retrieve scoped token details and manage organization OAuth credentials. [📄️ Configure connector OAuth\ -----------------------------\ \ Create or update OAuth credentials for the user's organization.](https://docs.airbyte.com/ai-agents/api/api-reference/update-oauth-credentials) [📄️ Delete connector OAuth\ --------------------------\ \ Delete OAuth credentials for the user's organization.](https://docs.airbyte.com/ai-agents/api/api-reference/delete-oauth-credentials-connector-type-connector-type) --- # Connectors | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/connectors#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Create, manage, and check configuration for end-user connectors. [📄️ Create a connector\ ----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors) [📄️ List connectors\ -------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-connectors) [📄️ Get a connector\ -------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-connectors-id) [📄️ Update a connector\ ----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-connectors-id) [📄️ Delete a connector\ ----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-connectors-id) [📄️ Execute actions\ -------------------\ \ Execute a connector operation using an Airbyte Platform connector ID.](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-execute) --- # Connectors (Advanced) | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/connectors-advanced#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Enable, configure, and disable connector templates for your organization. [📄️ Check config when creating a connector\ ------------------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-check) [📄️ Check config when updating a connector\ ------------------------------------------\ \ Check source configuration before updating an existing source.](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-check) [📄️ List connector definitions\ ------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-sources) [📄️ Get a connector definition\ ------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-sources-id) [📄️ Enable a connector\ ----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-sources) [📄️ List enabled connectors\ ---------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-sources) [📄️ Update an enabled connector\ -------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-sources-id) [📄️ Get an enabled connector\ ----------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-sources-id) [📄️ Disable a connector\ -----------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-sources-id) --- # Create Scoped Token | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-scoped-token#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Create Scoped Token =================== POST /api/v1/account/applications/scoped-token ----------------------------------------- **Requires an Access Token as the bearer token.** Generate a new scoped token. You can safely share it with your end users and it will allow them to manage their configured sources. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-scoped-token#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-scoped-token#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Generate Application Token | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-token#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Generate Application Token ========================== POST /api/v1/account/applications/token ---------------------------------- Generate an application access token using client credentials. This endpoint is intentionally unauthenticated - authentication is performed via client\_id and client\_secret in the request body. Returns a self-signed JWT token that can be used for all API calls. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-token#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-token#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Create Widget Token | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-widget-token#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Create Widget Token =================== POST /api/v1/account/applications/widget-token ----------------------------------------- **Requires an Access Token as the bearer token.** Generate a new widget token. You can safely pass it to your front-end application to instantiate a widget instance. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-widget-token#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-account-applications-widget-token#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Create a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Create a connector ================== POST /api/v1/integrations/connectors ------------------------------- **Requires an Access Token as the bearer token.** Create an end user's configured connector, config should be validated before. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Check config when creating a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-check#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Check config when creating a connector ====================================== POST /api/v1/integrations/connectors/check ------------------------------------- **Requires an Access Token as the bearer token.** Create a connector configuration check. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-check#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-check#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Execute actions | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-execute#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Execute actions =============== POST /api/v1/integrations/connectors/:id/execute ------------------------------------------- Execute a connector operation using an Airbyte Platform connector ID. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-execute#request "Direct link to request") -------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-execute#responses "Direct link to Responses") -------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Delete a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-connectors-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Delete a connector ================== DELETE /api/v1/integrations/connectors/:id ----------------------------------- **Requires an Access Token as the bearer token.** Delete an end user's configured connector. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-connectors-id#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-connectors-id#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------ * 202 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Delete connector OAuth | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/delete-oauth-credentials-connector-type-connector-type#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Delete connector OAuth ====================== DELETE /api/v1/oauth/credentials/connector\_type/:connector\_type ---------------------------------------------------------- Delete OAuth credentials for the user's organization. Deletes from Airbyte first, then soft-deletes the local record. Idempotent: returns 204 even if no record exists. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-oauth-credentials-connector-type-connector-type#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-oauth-credentials-connector-type-connector-type#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------------------------------- * 204 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Describe Cron Expression | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections-cron-describe#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Describe Cron Expression ======================== POST /api/v1/integrations/templates/connections/cron/describe -------------------------------------------------------- **Requires an Access Token as the bearer token.** Validate and describe a Quartz cron expression. Returns a human-readable description of when the schedule will run. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections-cron-describe#request "Direct link to request") ---------------------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections-cron-describe#responses "Direct link to Responses") ---------------------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Create Connection Template | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Create Connection Template ========================== POST /api/v1/integrations/templates/connections ------------------------------------------ **Requires an Access Token as the bearer token.** Create a connection template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections#request "Direct link to request") -------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections#responses "Direct link to Responses") -------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Check config when updating a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-check#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Check config when updating a connector ====================================== POST /api/v1/integrations/connectors/:id/check ----------------------------------------- Check source configuration before updating an existing source. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-check#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-connectors-id-check#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Enable a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-sources#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Enable a connector ================== POST /api/v1/integrations/templates/sources -------------------------------------- **Requires an Access Token as the bearer token.** Create a source\_template. End users can complete this template to create a source connector. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-sources#request "Direct link to request") ---------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-sources#responses "Direct link to Responses") ---------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Data replication | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/data-replication#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Configure connection templates and destination definitions for data replication. [📄️ List Destination Definitions\ --------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-destinations) [📄️ Get Destination Definition\ ------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-destinations-id) [📄️ List Connection Templates\ -----------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-connections) [📄️ Create Connection Template\ ------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections) [📄️ Describe Cron Expression\ ----------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/create-integrations-templates-connections-cron-describe) [📄️ Get Connection Template\ ---------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-connections-id) [📄️ Delete Connection Template\ ------------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-connections-id) [📄️ Patch Connection Template\ -----------------------------\ \ \*\*Requires an Access Token as the bearer token.\*\*](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-connections-id) --- # Delete Connection Template | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-connections-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Delete Connection Template ========================== DELETE /api/v1/integrations/templates/connections/:id ---------------------------------------------- **Requires an Access Token as the bearer token.** Delete a connection template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-connections-id#request "Direct link to request") ----------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-connections-id#responses "Direct link to Responses") ----------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Disable a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-sources-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Disable a connector =================== DELETE /api/v1/integrations/templates/sources/:id ------------------------------------------ **Requires an Access Token as the bearer token.** Delete a source template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-sources-id#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-integrations-templates-sources-id#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Delete Workspace | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/delete-workspaces-workspace-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Delete Workspace ================ DELETE /api/v1/workspaces/:workspace\_id --------------------------------- Delete an external user. Removes the external user from the Data Replication Platform and soft-deletes locally. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-workspaces-workspace-id#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/delete-workspaces-workspace-id#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get Scoped Token Info | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-account-applications-scoped-token-info#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get Scoped Token Info ===================== GET /api/v1/account/applications/scoped-token/info ---------------------------------------------- **Requires a Scoped Token as the bearer token.** Return metadata about a scoped token (workspace, organization...). Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-account-applications-scoped-token-info#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-account-applications-scoped-token-info#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-connectors-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get a connector =============== GET /api/v1/integrations/connectors/:id ----------------------------------- **Requires an Access Token as the bearer token.** Get an end user's configured connector. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-connectors-id#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-connectors-id#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get Destination Definition | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-destinations-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get Destination Definition ========================== GET /api/v1/integrations/definitions/destinations/:id ------------------------------------------------- **Requires an Access Token as the bearer token.** Get a destination connector specification. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-destinations-id#request "Direct link to request") ----------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-destinations-id#responses "Direct link to Responses") ----------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get Workspace Stats | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-stats#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get Workspace Stats =================== GET /api/v1/workspaces/stats ------------------------ Get external user statistics for the authenticated organization. Returns the count of active and inactive external users. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-stats#request "Direct link to request") ----------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-stats#responses "Direct link to Responses") ----------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get Connection Template | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-connections-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get Connection Template ======================= GET /api/v1/integrations/templates/connections/:id ---------------------------------------------- **Requires an Access Token as the bearer token.** Get a connection template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-connections-id#request "Direct link to request") -------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-connections-id#responses "Direct link to Responses") -------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get Workspace | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-workspace-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get Workspace ============= GET /api/v1/workspaces/:workspace\_id --------------------------------- Get a single external user by ID. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-workspace-id#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-workspace-id#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get a connector definition | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-sources-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get a connector definition ========================== GET /api/v1/integrations/definitions/sources/:id -------------------------------------------- **Requires an Access Token as the bearer token.** Get a source connector specification. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-sources-id#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-definitions-sources-id#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # List connectors | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-connectors#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List connectors =============== GET /api/v1/integrations/connectors ------------------------------- **Requires an Access Token as the bearer token.** List end user's configured connectors. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-connectors#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-connectors#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # List Workspaces | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/list-workspaces#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List Workspaces =============== GET /api/v1/workspaces ------------------ List external users for the authenticated organization with cursor-based pagination. * **name\_contains**: Optional filter by external user name (case-insensitive partial match) * **status**: Optional filter by external user status (active or inactive). If not specified, returns all external users. * **limit**: Maximum number of external users to return (default: 20, max: 100) * **cursor**: Pagination cursor from previous response's `next` URL * **next**: URL for next page (null if no more results) Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-workspaces#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-workspaces#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Get an enabled connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-sources-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Get an enabled connector ======================== GET /api/v1/integrations/templates/sources/:id ------------------------------------------ **Requires an Access Token as the bearer token.** Get a source template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-sources-id#request "Direct link to request") ---------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/get-integrations-templates-sources-id#responses "Direct link to Responses") ---------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Configure connector OAuth | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/update-oauth-credentials#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Configure connector OAuth ========================= PUT /api/v1/oauth/credentials ------------------------- Create or update OAuth credentials for the user's organization. This endpoint: 1. Extracts organization\_id from the user's token 2. Validates the configuration against the connector's OAuth spec 3. Stores secrets and replaces them with secret coordinates 4. Proxies the credentials to Coral's organization OAuth endpoint 5. Saves the record to Sonar's database Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-oauth-credentials#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-oauth-credentials#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # List connector definitions | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-sources#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List connector definitions ========================== GET /api/v1/integrations/definitions/sources ---------------------------------------- **Requires an Access Token as the bearer token.** List source connector specifications. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-sources#request "Direct link to request") ---------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-sources#responses "Direct link to Responses") ---------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # List Destination Definitions | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-destinations#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List Destination Definitions ============================ GET /api/v1/integrations/definitions/destinations --------------------------------------------- **Requires an Access Token as the bearer token.** Get a destination connector specification. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-destinations#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-definitions-destinations#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # List Connection Templates | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-connections#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List Connection Templates ========================= GET /api/v1/integrations/templates/connections ------------------------------------------ **Requires an Access Token as the bearer token.** List connection templates. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-connections#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-connections#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Update a connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-connectors-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Update a connector ================== PUT /api/v1/integrations/connectors/:id ----------------------------------- **Requires an Access Token as the bearer token.** Update an end user's configured connector, config should be validated before. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-connectors-id#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------ Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-connectors-id#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------ * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Update Workspace | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/update-workspaces-workspace-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Update Workspace ================ PUT /api/v1/workspaces/:workspace\_id --------------------------------- Update an external user's name, status, and/or cache setting. * Set `name` to update the external user name * Set `status` to 'active' or 'inactive' to change the external user status * When setting status to 'inactive', all active connections for the external user will be automatically disabled * Set `cache_enabled` to true/false to enable or disable Context Store caching for this external user Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-workspaces-workspace-id#request "Direct link to request") --------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-workspaces-workspace-id#responses "Direct link to Responses") --------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # List enabled connectors | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-sources#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List enabled connectors ======================= GET /api/v1/integrations/templates/sources -------------------------------------- **Requires an Access Token as the bearer token.** List source templates. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-sources#request "Direct link to request") -------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/list-integrations-templates-sources#responses "Direct link to Responses") -------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Workspaces | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/workspaces#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. List, retrieve, update, and delete workspaces with filtering and cursor-based pagination; get workspace statistics. [📄️ List Workspaces\ -------------------\ \ List external users for the authenticated organization with cursor-based pagination.](https://docs.airbyte.com/ai-agents/api/api-reference/list-workspaces) [📄️ Get Workspace Stats\ -----------------------\ \ Get external user statistics for the authenticated organization.](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-stats) [📄️ Get Workspace\ -----------------\ \ Get a single external user by ID.](https://docs.airbyte.com/ai-agents/api/api-reference/get-workspaces-workspace-id) [📄️ Update Workspace\ --------------------\ \ Update an external user's name, status, and/or cache setting.](https://docs.airbyte.com/ai-agents/api/api-reference/update-workspaces-workspace-id) [📄️ Delete Workspace\ --------------------\ \ Delete an external user. Removes the external user from the Data Replication Platform and soft-deletes locally.](https://docs.airbyte.com/ai-agents/api/api-reference/delete-workspaces-workspace-id) --- # Patch Connection Template | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-connections-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Patch Connection Template ========================= PATCH /api/v1/integrations/templates/connections/:id ---------------------------------------------- **Requires an Access Token as the bearer token.** Update a connection template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-connections-id#request "Direct link to request") ----------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-connections-id#responses "Direct link to Responses") ----------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error --- # Update an enabled connector | Airbyte Docs [Skip to main content](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-sources-id#__docusaurus_skipToContent_fallback) [Try Airbyte Cloud](https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar) ! Free for 30 days, no credit card needed. Update an enabled connector =========================== PATCH /api/v1/integrations/templates/sources/:id ------------------------------------------ **Requires an Access Token as the bearer token.** Update a source template. Request[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-sources-id#request "Direct link to request") ------------------------------------------------------------------------------------------------------------------------------------------- Responses[​](https://docs.airbyte.com/ai-agents/api/api-reference/update-integrations-templates-sources-id#responses "Direct link to Responses") ------------------------------------------------------------------------------------------------------------------------------------------------- * 200 * 400 * 403 * 422 * 500 Successful Response Bad request Forbidden Unprocessable entity Internal server error ---