REST API
Connect to any REST API that returns JSON data.
Connection Properties
| Property | Description |
|---|---|
| Base URL | The API endpoint URL. |
| Response Path | A JSONPath expression pointing to the data array in the response (e.g., $.data.items). |
| Auth Type | None, API Key, Bearer Token, or Basic Auth. |
| API Key Header | Header name (if using API Key). |
| API Key Value | Key value (if using API Key). |
| Bearer Token | The token (if using Bearer Token). |
| Username | Username (if using Basic Auth). |
| Password | Password (if using Basic Auth). |
Authentication Methods
- None: No authentication.
- API Key: Sends a key in a custom header.
- Bearer Token: Sends a token in the
Authorization: Bearerheader. - Basic Auth: Username and password sent as HTTP Basic authentication.
Tips
- The Response Path tells Semantic Modeler where to find the array of records in the JSON response. If the API returns
{"data": {"items": [...]}}, set the path to$.data.items. - The API must return a consistent schema across all records for table inference to work.