Intermediate5 min

AI API Import

Let AI analyze API documentation and create integrations automatically. No manual endpoint configuration needed.

How It Works

From Docs to Integration

  1. Provide API documentation
  2. AI analyzes endpoints
  3. Generates plugin structure
  4. You review and deploy

What AI Extracts

AI identifies:

  • API base URL
  • Authentication method
  • Available endpoints
  • Request parameters
  • Response formats

Import Methods

From URL

Import directly from documentation site:

  1. Go to Plugins > Import API
  2. Select AI Import
  3. Paste documentation URL
  4. Click Analyze

AI crawls and extracts endpoint information.

From Text

Paste documentation text:

  1. Select AI Import
  2. Choose Paste Documentation
  3. Paste API docs content
  4. Click Analyze

From Examples

Provide sample requests/responses:

  1. Select AI Import
  2. Choose From Examples
  3. Paste cURL commands or HTTP examples
  4. Click Analyze

Writing Good Inputs

URL Import Tips

Best results with:

  • Official API documentation pages
  • Structured reference docs
  • Pages with endpoint listings

Text Import Tips

Include:

  • Endpoint paths
  • HTTP methods
  • Request/response examples
  • Authentication info

Example Input

## Create User
POST /api/v1/users

Request:
{
  "name": "John Doe",
  "email": "john@example.com"
}

Response:
{
  "id": "123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}

Authentication: Bearer token in Authorization header

AI Analysis Results

Detected Components

After analysis, you'll see:

| Component | Example | |-----------|---------| | Base URL | https://api.example.com/v1 | | Auth Type | Bearer Token | | Endpoints | 12 detected | | Actions | 8 generated |

Generated Actions

For each endpoint:

  • Action name
  • Description
  • Input parameters
  • Output schema

Confidence Score

AI shows confidence:

  • High - Clear documentation
  • Medium - Some ambiguity
  • Low - Incomplete information

Review Process

Verify Endpoints

Check each generated action:

  1. Correct HTTP method?
  2. Path looks right?
  3. Parameters complete?
  4. Authentication correct?

Make Corrections

If something's wrong:

  • Edit action details
  • Add missing parameters
  • Fix data types
  • Adjust authentication

Test Before Saving

  1. Configure credentials
  2. Test an endpoint
  3. Verify response
  4. Fix any issues

Common Scenarios

REST API Docs

Works great with:

  • Swagger UI pages
  • Readme.io documentation
  • Postman collections
  • Standard REST references

GraphQL

For GraphQL APIs:

  • Provide schema or introspection
  • AI generates query actions
  • Mutations become actions

Partial Documentation

If docs are incomplete:

  • AI does its best
  • Marks uncertain items
  • You fill in gaps

Tips for Best Results

1. Use Official Docs

Official documentation is most reliable.

2. Include Auth Info

Clearly state authentication method.

3. Provide Examples

Real request/response examples help AI.

4. Verify Results

Always test generated endpoints.

After Import

Complete Setup

  1. Review all actions
  2. Configure authentication
  3. Test key endpoints
  4. Save the plugin

Use in Workflows

Your new API is available:

  1. Open workflow editor
  2. Find in Plugins panel
  3. Drag actions to canvas
  4. Configure and connect

Limitations

What AI May Miss

  • Complex authentication flows
  • Dynamic URL patterns
  • Webhooks setup
  • Rate limiting rules

Manual Additions

You may need to add:

  • Webhook configurations
  • Pagination handling
  • Error response mapping
  • Custom headers

Troubleshooting

No Endpoints Found

  • Check URL accessibility
  • Provide more documentation
  • Try text input instead

Wrong Parameters

  • Provide clearer examples
  • Edit manually
  • Check API version

Auth Not Detected

  • Explicitly state auth type
  • Include auth examples
  • Configure manually

Next Steps

Tags

aiapiimport