Import OpenAPI Schema
Instead of adding API actions one by one, you can import several at once from an existing OpenAPI (Swagger) definition. This tutorial walks you through the import flow — from opening the modal to publishing the result.
When to Use This Feature
Use Import OpenAPI Schema when you already have an OpenAPI spec for your backend. Rather than manually filling in the name, HTTP method, endpoint, and parameters for each operation, qlar reads the spec and creates all the API actions in one step.
Common scenarios:
- You exported a spec from Postman, Swagger UI, or your API gateway
- Your backend team maintains an OpenAPI file as part of their development workflow
- You are migrating a large set of endpoints from another tool
Step 1 — Open the Import Modal
On the Custom API page, click Import OpenAPI Schema in the top section of the page. A modal dialog opens.
Step 2 — Choose the Schema Format
Set Schema Format to JSON or YAML depending on your spec file.
Tip: If you upload a file in the next step, qlar detects the format automatically from the file extension (
.json,.yaml, or.yml) and sets this field for you.
Step 3 — Provide the Schema
You have two options:
Option A — Paste
Copy your OpenAPI spec and paste it directly into the Paste your OpenAPI schema here editor.
Option B — Upload a file
Click Choose File and select a .json, .yaml, or .yml file from your computer. The file content fills the editor automatically.
Step 4 — Convert the Schema
Click Convert Schema. A confirmation dialog appears summarising how many API actions will be created.
Click Confirm to proceed. qlar parses the spec and adds one API action per operation to your list.
Note: Each imported action is added without authentication. After importing, configure credentials for your APIs — either one by one (see the Authentication section in Call API) or all at once using Set Authentication.
Step 5 — Review the Imported APIs
The modal closes and your Custom API list now shows the newly imported actions. Check each one to confirm the name, description, HTTP method, endpoint, and parameters look correct.
You can click the edit (pencil) icon on any action to adjust its details before publishing.
Step 6 — Publish All Changes
Click Save all changes at the bottom of the Custom API page. A confirmation dialog appears — click Confirm to publish.
All imported API actions are now live on your agent.
What Gets Imported
| OpenAPI field | Maps to qlar field |
|---|---|
operationId / summary | Action Name |
description | Description |
method | HTTP Method |
servers[0].url + path | Target URI |
parameters | Properties (path, query) |
requestBody | Properties (body) |
Note: The import covers the most common OpenAPI 3.x fields. Some advanced constructs (e.g., complex
allOf/oneOfschemas, file upload parameters) may not map fully and will need manual adjustment after import.
Next Steps
- Add authentication — See Set Authentication to apply credentials to all imported APIs at once.
- Test an action — Open the edit panel for any imported action, click Test API, fill in sample values, and click Send Request to verify the endpoint responds correctly.
- Refine descriptions — The AI uses the action name and description to decide when to call each API. If a description is missing or generic, update it to be more specific.
Related Pages
- Call API — register a single API action manually and understand all available options
- Set Authentication — apply credentials to multiple APIs in one step
- Using Plugins — use pre-built integrations instead of configuring raw APIs