API builder is a visual, low-code canvas in integrator.io for building APIs. You define the request your API accepts, add lookups, imports, AI agents, and other steps that run your business logic, and define the responses your API returns. This article describes the canvas components and how an API runs from request to response, and points you to the article for each task.
What you can build with API builder
API builder supports these needs:
- Combine operations. Run several lookups, imports, and processing steps in one API.
- Reuse logic. Use existing lookups and imports, and add AI agents, guardrails, and tools.
- Route requests. Send requests down different paths based on conditions.
- Control failures. Return custom errors, check requests and responses against your schemas, and review request logs.
The API builder canvas
Every new API starts with one API request, a Response picker, a Success response, and an Error response. You add steps between the request and the Response picker.
Tabs and toolbar
| Component | Description |
|---|---|
| Build | The canvas where you create and configure the API. |
| Request history | Request logs for the API. See View API request and execution logs in API builder. |
| Connections | The connections the API uses and their status. |
| Audit log | Changes made to the API's resources. |
| Run test | Runs the API with mock request data. See Test and debug your API using API builder. |
| Enable debug mode | Captures detailed logs while you test. See View API request and execution logs in API builder. |
| Settings | The API's name, description, version, invoke URL, and advanced settings. See Configure advanced API settings. |
| Actions | Actions for the API, such as cloning, disabling, and deleting. See Create and manage APIs using API builder. |
Canvas nodes
| Component | Description |
|---|---|
| API request | Defines what callers send: the HTTP method, relative URI, parameters, headers, and body. See Configure an API request using API builder. |
| Step | A destination, lookup, AI agent, tool, or guardrail that runs your business logic. Select + to add one. See Configure lookups, imports, guardrails, AI agents, and tools in API builder. |
| Transformation | Reshapes data between two steps. Select the icon on the connecting line to open it. See Configure an API request using API builder. |
| Branching router | Splits the API into branches based on conditions. See Branching in API builder. |
| Response picker | A built-in router at the end of the API that selects which response to return. See Branching in API builder. |
| API response | Defines what the API returns: the HTTP status code, headers, and body. New APIs include a Success response and an Error response. See Configure an API response using API builder. |
Use the controls at the lower left of the canvas to zoom in, zoom out, fit the API to the screen, and show a mini-map. You can drag steps to a different location. Their mappings and other configuration move with them.
How an API runs
When a caller invokes your API, the API runs in this order:
- The API receives the request. The caller must send a valid API token. See Invoke an API and API limits.
- The API request node passes the path parameters, query parameters, headers, and body to the first step under named keys.
- Each step runs in order. At a branching router, the request flows through the first branch whose conditions it matches.
- If a step fails, the API follows the failure behavior you set for that step. See Error handling in API builder.
- The Response picker selects the response. By default, the Success response runs when the API succeeds, and the Error response runs when it doesn't.
- The response node returns the status code, headers, and body to the caller.
Where to go next
| To | See |
|---|---|
| Create an API | Create and manage APIs using API builder |
| Clone, move, delete, or turn an API on or off | Create and manage APIs using API builder |
| Define the request and response | Configure an API request using API builder, Configure an API response using API builder |
| Check requests and responses against schemas | Validate API requests and responses in API builder |
| Move data between steps | Mapping data in API builder |
| Set the timeout, pagination, and offline behavior | Configure advanced API settings |
| Test and diagnose | Test and debug your API using API builder, View API request and execution logs in API builder, Troubleshoot APIs |
| Call the API | Invoke an API and API limits |
| See complete sample APIs | API builder examples |
Related articles
- Create and manage APIs using API builder
- Configure an API request using API builder
- Configure an API response using API builder
- Validate API requests and responses in API builder
- Configure lookups, imports, guardrails, AI agents, and tools in API builder
- Branching in API builder
- Mapping data in API builder
- Configure advanced API settings
- Test and debug your API using API builder
- View API request and execution logs in API builder
- Error handling in API builder
- Troubleshoot APIs
- Invoke an API and API limits
- API builder examples