OpenAPI Import

Import existing OpenAPI 3.x specifications to automatically create integrations with operations, authentication methods, and schemas.

If the external API you want to integrate with has an OpenAPI 3.x specification, you can import it directly. The platform converts the OpenAPI document into its native integration format, saving you from manually defining each operation.

What gets imported

The converter maps OpenAPI components to the platform's integration model:

OpenAPI component	Platform equivalent
Paths + Methods	Operations (one per path/method combination)
Security Schemes	Auth methods (OAuth2, API Key, Bearer, Basic)
Request Bodies	Input parameters with body location
Path/Query/Header Parameters	Input parameters with appropriate location
Response Schemas	Output definitions
Components/Schemas	Data types
Operation IDs	Operation identifiers (used for deterministic action UIDs)

Import process

Provide the OpenAPI document — either as a JSON/YAML file upload or a URL to the spec.
The converter processes it — paths, methods, parameters, schemas, and security schemes are extracted and mapped.
An integration is created — with all operations, auth methods, and data types populated.
Actions are generated — each operation becomes a callable action in the blueprint.

How the conversion works

Operations

Each path + method combination becomes an operation:

GET /users → operation listUsers
POST /users → operation createUser
GET /users/{id} → operation getUser

Operation IDs from the OpenAPI spec are preserved, ensuring stable and predictable action UIDs.

Parameters

OpenAPI parameter definitions are mapped to the platform's parameter model:

in: path → location: path
in: query → location: query
in: header → location: header
Request body → location: body

Required/optional status, types, and descriptions are preserved.

Authentication

Security schemes are converted to auth methods:

OpenAPI scheme	Platform auth method
`http: basic`	basic
`http: bearer`	bearer
`apiKey`	apikey
`oauth2`	oauth2 (with authorization URL, token URL, scopes)

Schemas

Component schemas are imported as data types and referenced by operations that use them.

After import

Once imported, the integration works exactly like a manually defined one:

Operations appear as actions in the blueprint
Auth methods are available for connection creation
You can use the actions in flows and agent configurations
The integration can be edited to add custom configuration, transforms, or event channels

Limitations

Only OpenAPI 3.x is supported. Swagger 2.0 documents should be converted to OpenAPI 3.x first.
Complex OpenAPI features like oneOf, allOf discriminators are supported but may require manual adjustment.
Callback and link objects are not automatically converted to event channels.

Creating Integrations — manually defining integrations
Connections — authenticating with the imported API
Actions — the generated actions from imported operations

OpenAPI Import

On this page