Airbyte Configuration API

{
  "service_type": "platform",
  "base_url": "https://airbyte.local:config",
  "auth_method": "api_key",
  "auth_config": {
    "header": "Authorization",
    "scheme": "Bearer",
    "description": "Airbyte Configuration API uses bearer token authentication. Obtain an API token from the Airbyte instance's settings or via the login endpoint."
  },
  "endpoints": [
    {
      "name": "list_workspaces",
      "method": "POST",
      "path": "/v1/workspaces/list",
      "description": "List all workspaces in the Airbyte instance.",
      "auth_required": true,
      "request_body": {},
      "response_example": {
        "workspaces": [
          {"workspaceId": "uuid", "name": "My Workspace"}
        ]
      }
    },
    {
      "name": "list_sources",
      "method": "POST",
      "path": "/v1/sources/list",
      "description": "List all source connectors configured in a given workspace.",
      "auth_required": true,
      "request_body": {
        "workspaceId": "string (uuid)"
      },
      "response_example": {
        "sources": [
          {"sourceId": "uuid", "name": "My Source", "sourceName": "Postgres"}
        ]
      }
    },
    {
      "name": "create_source",
      "method": "POST",
      "path": "/v1/sources/create",
      "description": "Create a new source connector with a specified connector definition and configuration.",
      "auth_required": true,
      "request_body": {
        "workspaceId": "string",
        "name": "string",
        "sourceDefinitionId": "string (uuid)",
        "connectionConfiguration": {},
        "secretManager": "optional"
      },
      "response_example": {
        "sourceId": "uuid",
        "name": "My Source",
        "sourceDefinitionId": "uuid",
        "workspaceId": "uuid",
        "connectionConfiguration": {"key": "redacted or value"},
        "sourceName": "string"
      }
    },
    {
      "name": "list_connections",
      "method": "POST",
      "path": "/v1/connections/list",
      "description": "List all connections (syncs) in a workspace.",
      "auth_required": true,
      "request_body": {
        "workspaceId": "string (uuid)"
      },
      "response_example": {
        "connections": [
          {"connectionId": "uuid", "name": "My Connection"}
        ]
      }
    },
    {
      "name": "create_connection",
      "method": "POST",
      "path": "/v1/connections/create",
      "description": "Create a new connection between a source and a destination.",
      "auth_required": true,
      "request_body": {
        "sourceId": "string",
        "destinationId": "string",
        "name": "string",
        "syncCatalog": {"streams": []},
        "schedule": {"basicSchedule": {"timeUnit": "hours", "units": 24}},
        "status": "active",
        "namespaceDefinition": "source",
        "optionalStreams": {}
      },
      "response_example": {
        "connectionId": "uuid",
        "sourceId": "uuid",
        "destinationId": "uuid",
        "status": "active"
      }
    },
    {
      "name": "list_destination_definitions",
      "method": "POST",
      "path": "/v1/destination_definitions/list",
      "description": "List all available destination connector definitions.",
      "auth_required": true,
      "response_example": {
        "destinationDefinitions": [
          {"destinationDefinitionId": "uuid", "name": "BigQuery", "dockerRepository": "airbyte/destination-bigquery"}
        ]
      }
    }
  ],
  "pricing_model": {
    "type": "freemium",
    "details": {
      "description": "Airbyte is an open-source data integration platform with a commercial cloud offering. The self-hosted open-source version is free, while Airbyte Cloud offers usage-based pricing. The Configuration API is available for self-managed and Cloud instances. Refer to Airbyte pricing page for detailed tiers."
    }
  },
  "rate_limits": {
    "type": "unknown",
    "description": "No standard rate limits documented for the Configuration API on self-managed Airbyte. For Airbyte Cloud, rate limits may apply to API usage but specifics are not public."
  },
  "capabilities": [
    "Manage workspaces, sources, destinations, and connections",
    "Create, list, update, and delete source and destination connectors",
    "Configure sync schedules and catalog streams for data replication",
    "Trigger manual syncs and check connection status",
    "Discover source schemas to build sync catalogs",
    "Manage connector definitions (list custom and available connectors)",
    "Support for user and workspace management (permissions, tokens)",
    "OpenAPI specification for code generation",
    "Health checks and version endpoints for operational monitoring",
    "Supports both open-source self-hosted and cloud-hosted instances"
  ],
  "raw_analysis": "Airbyte Configuration API is a vital component of the Airbyte data integration platform, providing programmatic access to configure, manage, and orchestrate data pipelines (sources, destinations, connections) that mo

0/3 tests passed

{
  "overall": 68,
  "dimensions": {
    "token_efficiency": 7.5,
    "first_try_success": 7.0,
    "response_parseability": 8.0,
    "error_clarity": 6.0,
    "doc_quality": 8.5,
    "auth_simplicity": 6.5,
    "latency": 6.0,
    "consistency": 7.5
  },
  "pricing_normalized": {
    "open_source": "free",
    "cloud": "usage-based, with free tier",
    "api": "available on both self-hosted and cloud, credit-metered on cloud"
  },
  "issues": [
    {
      "issue": "The website checks returned 'Invalid port' errors for all endpoints (including llms.txt), suggesting the test harness misconfigured the URL or the site's routing rejects requests with unexpected paths.",
      "impact": "Unable to confirm uptime, latency, or documentation accessibility programmatically; user/agent may face similar connectivity issues if endpoint paths are strict."
    },
    {
      "issue": "No llms.txt discovered, meaning agents may lack a quick-reference for API usage and need to scan broader docs.",
      "impact": "Less efficient for AI agents to find key endpoints and capabilities without extra context."
    },
    {
      "issue": "The platform is large (Airbyte) — onboarding involves creating custom connectors, schemas, and sync configs. Time-to-productivity may be minutes for basic but hours for full pipeline setup.",
      "impact": "New agents may need multiple API calls to configure a complete data pipeline, lower first-try success."
    }
  ],
  "recommendations": [
    {
      "recommendation": "Add a llms.txt file at the root of the API docs site so AI agents can discover configuration API endpoints and parameters efficiently.",
      "rationale": "Improves token efficiency and reduces guesswork for agents."
    },
    {
      "recommendation": "Provide clearer guidance on authentication methods (API keys vs OAuth flows) in a single 'Get Started' block with env variable examples.",
      "rationale": "Simplifies auth for agents and reduces error rate during first calls."
    },
    {
      "recommendation": "Publish a stable, versioned OpenAPI spec URL that agents can fetch to generate SDK stubs on the fly.",
      "rationale": "Ensures structured response-parseability and consistent usage across versions."
    }
  ]
}