API Builder Integration
The API Builder extends AIPI by letting you create custom integrations with any REST API. When you build a custom integration, it becomes accessible through AIPI just like any built-in Vantage integration.
How API Builder Fits into AIPI
| Integration Type | How It's Created | AIPI Access |
|---|---|---|
| Built-in | Pre-configured by Intuidy | Available immediately after connecting credentials |
| Custom (API Builder) | You define endpoints, parameters, and response mapping | Available after saving the definition and adding credentials |
Both types are accessed through AIPI the same way. Your frontend code doesn't need to know whether an integration is built-in or custom.
When to Use API Builder
Use the API Builder when you need to connect to a service that Vantage doesn't have a built-in integration for:
- Internal APIs — Connect to your company's internal microservices
- Industry-specific tools — ERP systems, field service platforms, compliance databases
- Niche SaaS products — Specialized tools your team uses daily
- Government/public APIs — Census data, weather services, regulatory databases
- Partner APIs — Connect to vendor or partner systems for data exchange
Building a Custom Integration
The API Builder uses a 4-step wizard:
Step 1: General Information
| Field | What You Enter |
|---|---|
| Display Name | A friendly name (e.g., "Internal CRM", "Weather Service") |
| Base URL | The API's root URL (e.g., https://api.example.com/v1) |
| Auth Type | API Key, Bearer Token, Basic Auth, or No Auth |
Step 2: Define Endpoints
For each API operation:
- HTTP Method — GET, POST, PUT, or DELETE
- Path — The endpoint path (e.g.,
/customers/{id}) - Parameters — Query, path, header, or body parameters
- Response Mapping — Map JSON response fields to structured workflow outputs
Step 3: Response Configuration
Use the JSON Response Parser to:
- Paste a sample JSON response from the API
- Select which fields to extract
- Set output labels for use in workflows
Step 4: Save & Add Credentials
- Save the integration definition
- Add your API key, token, or credentials
- The integration becomes available as a workflow node and through AIPI
Using Custom Integrations Through AIPI
Once a custom integration is saved and credentialed:
-
In Workflows — The integration appears as a node in the Workflow Editor's Node Library. Drag it onto the canvas, select an endpoint, and map parameters.
-
Through AIPI — Trigger workflows that use the custom integration from your frontend application. The workflow handles the API call and returns structured results.
-
In AI Agents — Agents with integration skills can access custom integrations just like built-in ones.
Example: Connecting a Custom CRM
| Step | Action |
|---|---|
| 1. Find the API docs | Locate the CRM's developer documentation for base URL, auth method, and endpoints |
| 2. Build in API Builder | Create the integration with endpoints like GET /customers/{id} and POST /deals |
| 3. Map responses | Use the JSON parser to extract customer name, email, deal value, stage, etc. |
| 4. Add credentials | Enter your CRM API key |
| 5. Build a workflow | Create a workflow that queries the CRM and returns structured customer data |
| 6. Call from your app | Trigger the workflow through AIPI from your frontend |
For More Details
- API Builder Overview — Full setup guide with technical requirements
- REST API Fundamentals — HTTP methods, auth types, and JSON concepts
- Wizard Walkthrough — Step-by-step wizard documentation
- JSON Response Parser — Deep dive into response mapping
- Examples — Three complete real-world integrations
- Troubleshooting — Common issues and glossary
Next Steps
- Security & Authentication — How AIPI protects your data and controls access
- Use Cases & Examples — Application patterns built on AIPI