API Builder Reference
Vantage provides an API Builder for creating custom API endpoints. This is the primary way to expose APIs from the platform.
Overview
The API Builder lets you create HTTP endpoints backed by Vantage workflows:
- Define an endpoint with a method (GET, POST, PUT, DELETE) and path
- Connect it to a workflow using Workflow Input and Workflow Output nodes
- The endpoint processes requests through the workflow and returns results
Creating Endpoints
| Setting | Description |
|---|---|
| Name | Descriptive name for the endpoint |
| Method | HTTP method (GET, POST, PUT, PATCH, DELETE) |
| Path | URL path with optional parameters (:id, :name) |
| Description | What the endpoint does |
Connecting to Workflows
Input
Use the Workflow Input node as the first node in your workflow to receive data from the API request (path parameters, query strings, request body).
Processing
Add any workflow nodes for data processing — database queries, transformations, AI analysis, etc.
Output
Use the Workflow Output node as the last node to define the response data sent back to the API caller.
Monitoring
View API call history on the API Calls page:
- Request timestamp
- Endpoint called
- HTTP status code
- Response time
- Request/response payloads
For More Details
- API Builder Overview — Full setup guide
- API Configuration — Detailed configuration options
- API Builder Page — App page documentation
- Workflow Input Node — Node reference
- Workflow Output Node — Node reference