Skip to content
Vendia

API Connections

API Connections enable AI applications to discover and interact with your APIs by adding OpenAPI or Swagger specification files. Instead of manually describing API endpoints to AI agents or building custom integrations, simply add your API specification and give AI agents the ability to understand and call your APIs — whether they’re internal or external APIs, or third-party integrations.

With API Connections, you unlock powerful AI-driven API workflows while maintaining control over which APIs are exposed, how they are accessed, and who can use them:

  • Leverage Existing Specifications: AI agents work directly with your OpenAPI/Swagger specifications — no need to rewrite or translate your API documentation
  • Enable API Discovery: AI applications can explore available endpoints, understand parameters, and make informed API calls
  • Simplify Integration: Add once and let AI agents handle the complexity of API interactions
  • Support Multiple APIs: Add multiple API specifications to give AI agents access to diverse services

Use Cases

API Connections enable a wide range of AI-driven workflows:

  • AI Workflow Automation: AI agents can orchestrate multi-step workflows across internal or external APIs
  • Internal Service Integration: Give AI agents access to your internal microservices and APIs
  • Third-Party API Discovery: Enable AI to explore and use external APIs like Slack, JIRA, or Snowflake
  • Automated Testing: Let AI agents generate and execute API test cases based on specifications
  • API Documentation: AI can answer questions about API capabilities by reading the specification

Getting Started

  1. Prepare Your API Specification: Ensure you have a valid OpenAPI or Swagger specification file in JSON, YAML, or YML format
  2. Add to Vendia: Use the Vendia console to create a new API Connection entry
  3. Configure Settings: Set optional parameters like base URL override, version override, custom headers, and description
  4. Save the Connection: Connections are automatically enabled when saved
  5. Use with AI Applications: AI agents can now discover and interact with your APIs through MCP-compatible applications

Supported Specification Formats

API Connections support the following specification formats:

FormatExtensionsDescription
JSON.jsonOpenAPI/Swagger specifications in JSON format
YAML.yaml, .ymlOpenAPI/Swagger specifications in YAML format

Configuration Options

When creating an API Connection, you can configure the following settings:

Required Fields

  • API Name: A unique identifier for your API (e.g., “Snowflake”, “slack”, “JIRA”)
  • OpenAPI/Swagger File: The specification file to add in JSON, YAML, or YML format (max file size: 5MB)

Optional Fields

  • Description: A brief description of the API and its purpose (max 500 characters)
  • Base URL Override: Override the base URL from the specification (e.g., https://api.example.com)
  • Version Override: Override the version from the specification using numeric semantic versioning format (e.g., 1.0.0, 2.1.3, 3.0.0)
  • Headers: Add custom headers to include in API requests, such as authentication tokens or API keys

Managing API Connections

Creating an API Connection

  1. Navigate to File Sharing → API Connections in the Vendia console
  2. Click “Add API Connection” in the upper right
  3. Enter the required API Name
  4. Upload your OpenAPI/Swagger specification file
  5. Optionally configure:
    • Description
    • Base URL Override
    • Version Override (semantic versioning: MAJOR.MINOR.PATCH)
    • Custom headers for authentication
  6. Click “Upload API Specification” to create the connection (automatically enabled)

Enabling and Disabling Connections

Toggle the Enabled switch for each API Connection to control whether it’s available to AI applications. Disabled connections are not accessible to AI agents.

Updating API Connections

To update an API Connection, you can use either of these methods:

Option 1: Click the API Connection name

  1. Click on the API Connection name in the list to open the edit view
  2. Make your changes to settings or upload a new specification file
  3. Click Save Changes

Option 2: Use the Actions menu

  1. Click the Actions menu (three dots) for the connection you want to modify
  2. Select “Edit” to open the edit view
  3. Make your changes and click Save Changes

Deleting API Connections

To remove an API Connection:

  1. Click the Actions menu (three dots) for the connection you want to delete
  2. Select “Delete”
  3. Confirm the deletion

Deletion Impact

Deleting an API Connection immediately removes it from AI applications. Any AI agents currently using the connection will lose access.

Prerequisites

Before creating your first API Connection, ensure you have:

  1. Valid API Specification: An OpenAPI or Swagger specification file in JSON, YAML, or YML format
  2. API Access: If the API requires authentication, have your API keys or tokens ready
  3. Vendia Account: Access to the Vendia Free Tier or Enterprise Tier console

File Size and Limits

Free Tier Limits

  • Maximum API Connections: Up to 2 API Connection entries

All Tier Limits

  • Maximum Specification File Size: 5MB per specification file
  • Supported Formats: JSON, YAML, YML
  • Operations per Connection: Maximum 25 operations per API Connection
  • MCP Calls: Up to 100,000 MCP calls per month (shared across all resources)
  • Concurrent Requests: Maximum of 2 concurrent requests

Security Considerations

Authentication

API Connections do not automatically handle authentication. You have several options:

  1. Custom Headers: Add API keys, bearer tokens, or other authentication headers in the connection configuration
  2. Public APIs: For public APIs without authentication, no additional configuration is needed

Credential Security

Be cautious when adding authentication credentials to headers. Ensure your Vendia account is secure and consider using short-lived tokens or API keys with limited scope.

Additional Resources

For more information about configuring and using API Connections:

For more information about Vendia MCP Gateway: