Skip to main content
Import API documentation automatically from OpenAPI (Swagger) specification files. AGO parses your API spec and generates structured documentation for your AI agents.

​
Overview

The OpenAPI connector:
  • Parses OpenAPI 2.0 (Swagger) and OpenAPI 3.x specifications
  • Auto-generates one document per API endpoint
  • Includes endpoint details (method, path, parameters, request/response schemas)
  • Creates an overview document with API metadata

​
Prerequisites

  • OpenAPI specification file (JSON or YAML format)
  • Valid OpenAPI 2.0 or 3.x syntax

​
Setup

1

Prepare Your Spec File

Ensure your OpenAPI specification is valid:
  • Use a validator like Swagger Editor
  • Fix any validation errors before import
2

Create Knowledge Source

  1. Navigate to Knowledge → Sources
  2. Click Create Source
  3. Select OpenAPI as the source type
  4. Provide the path to your specification file (JSON or YAML)
  5. Save the source
3

Sync Content

  1. Click Sync to import the documentation
  2. Review generated documents in the source tree

​
Generated Content

The connector creates documentation for:
Schemas and models are included within each endpoint document rather than as separate documents. Deprecated endpoints are automatically flagged.

​
Best Practices

  • Keep your OpenAPI spec up to date
  • Use descriptive summaries and descriptions in your spec
  • Organize endpoints with tags for better categorization
  • Re-sync after API changes

​
Troubleshooting

Symptom: Sync fails with validation errors.Solution: Validate your spec file with an OpenAPI validator and fix any issues.
Symptom: Generated docs have minimal content.Solution: Add description fields to your OpenAPI spec for endpoints, parameters, and schemas.