API Setup and Configuration

This comprehensive guide walks you through the process of connecting and configuring APIs in Solariz.

Adding a New API

Follow these steps to add your first API:

Navigate to the APIs section using the sidebar menu

Click the Add New API button

Complete the required fields in the form

Click Create API to proceed

Required Fields

API Name*

A descriptive name (e.g., 'Weather API')

Base URL*

The root URL (e.g., https://api.example.com)

Description

What this API does (this helps the AI understand its purpose)

Configuration Overview

The API Configuration page allows you to set up authentication and security settings for your Solariz integration. Here's what you can configure:

Choose Authentication Type

Select between None, Universal, or User-based authentication (coming soon)

Configure Key Placement

Decide where your API key should be placed in requests

Set Parameter Names

Customize the parameter name for your API key

Add Your API Key

Enter your universal API key for authentication

Universal API Key Configuration

If your API uses a universal key, configure these settings:

Key Placement Options:

Request Header

Add the key to the request headers

Query Parameter

Include the key in the URL

Request Body

Place the key in the request body (for POST/PUT)

Configuration Steps:

For headers: Enter header name (e.g., X-API-Key)

For query parameters: Enter parameter name (e.g., api_key)

Enter your Universal API Key value

Click Create Configuration to save

Defining API Endpoints

After setting up authentication, you need to define the endpoints:

🔐 Security Warning

Do not include API keys in your endpoint specifications. API keys should only be added in the dedicated authentication configuration section. This ensures your sensitive credentials remain secure and properly managed within the system.

Auto-discover

Import from an OpenAPI/Swagger specification or Postman Collection

Add Manually

Define endpoints one by one

Auto-Discovery Process:

Select specification type (OpenAPI/Swagger or Postman Collection)

Paste your API specification in the text area

Click Parse Specification to extract endpoints

Review the discovered endpoints

Click Save Endpoints to finalize

Manual Configuration:

Set the Endpoint Name (e.g., 'Get Current Weather')

Specify the Path (e.g., /weather/current)

Select the HTTP Method (GET, POST, PUT, DELETE, etc.)

Add a Description to help the AI understand its purpose

Define Parameters (query parameters, path variables, request body fields)

Save your endpoint configuration

Test Your API

Once you've configured your API and endpoints, test the integration by sending queries:

Simple Query

Test basic functionality with straightforward requests

Example: "Get the current weather for New York"

Complex Query

Test advanced features with multi-step or conditional requests

Example: "Get weather forecast for multiple cities and compare temperatures"

Documentation