Intermediate5 min
OpenAPI Import
Import APIs automatically from OpenAPI (Swagger) specifications. The fastest way to add complex APIs.
What is OpenAPI?
OpenAPI (formerly Swagger) is a standard format for describing REST APIs:
- Defines endpoints
- Describes parameters
- Documents responses
- Specifies authentication
Importing from OpenAPI
From URL
- Go to Plugins > Import API
- Select OpenAPI/Swagger
- Enter the spec URL:
https://api.example.com/openapi.json - Click Fetch
- Review detected endpoints
- Click Import
From File
- Go to Plugins > Import API
- Select OpenAPI/Swagger
- Click Upload File
- Select your
.jsonor.yamlfile - Review and import
From Paste
- Go to Plugins > Import API
- Select OpenAPI/Swagger
- Click Paste Spec
- Paste your OpenAPI content
- Review and import
Supported Versions
| Version | Support | |---------|---------| | OpenAPI 3.1 | Full | | OpenAPI 3.0 | Full | | Swagger 2.0 | Full | | Swagger 1.x | Partial |
What Gets Imported
Endpoints
All defined paths become available actions:
- Method (GET, POST, etc.)
- Path with parameters
- Description
Parameters
Automatically detected:
- Path parameters (
/users/{id}) - Query parameters (
?page=1) - Body schemas
- Headers
Authentication
Supported security schemes:
- API Key
- Bearer Token
- Basic Auth
- OAuth 2.0
Schemas
Request and response models:
- Object structures
- Required fields
- Types and formats
After Import
Review Endpoints
Check that imports look correct:
- Open the imported API
- Browse actions
- Verify parameters
- Test an endpoint
Configure Auth
If not auto-detected:
- Go to Authentication
- Select method
- Enter credentials
- Save
Customize
Adjust as needed:
- Rename actions
- Add descriptions
- Set default values
- Hide unused endpoints
Common Issues
Spec Not Loading
- Check URL is accessible
- Verify CORS allows access
- Try downloading and uploading
Missing Endpoints
- Spec may be incomplete
- Some endpoints might be excluded
- Add manually if needed
Wrong Parameters
- Review the original spec
- Edit manually in our platform
- Contact API provider
Finding OpenAPI Specs
From API Documentation
Many APIs link to their spec:
- Look for "OpenAPI" or "Swagger" links
- Often at
/openapi.jsonor/swagger.json - Check developer documentation
Public Registries
- APIs.guru
- SwaggerHub
- GitHub repositories
Generate from Docs
Some tools can generate specs:
- Postman export
- Insomnia export
- AI generation from docs
Best Practices
1. Use Official Specs
When available, use the API provider's official spec.
2. Keep Updated
Re-import when API changes:
- Delete old import
- Import updated spec
- Update affected workflows
3. Test After Import
Always verify imported endpoints work before building workflows.
Next Steps
- Importing APIs - Other methods
- OAuth Connections - Configure auth
- Custom Plugins - Build plugins
Tags
integrationsopenapiswagger