REST API

How to Complete the REST API Data Source Form?

Looking at this REST API loader form, here's what you need to do to complete it:

Step-by-Step Instructions:

1. Name (Required)

• Enter a name for your data source in the text box

• This helps you identify your API data later

• Example: "Customer API," "Product Catalog," or "Weather Data"

• The placeholder shows "My REST API" as an example

• ⚠️ This field is required (red warning shown)

2. API URL (Required)

• Enter the base URL of the REST API you want to connect to

• Example: https://api.example.com/v1

• Make sure the URL is complete and accessible

• ⚠️ This field is required (red warning shown)

3. Headers (Optional)

• Add any headers needed for the API request

• Common examples:

  • Authorization: Bearer my_token

  • Content-Type: application/json

  • X-API-Key: your_api_key

• Format: One header per line

• You can leave this empty if no special headers are needed

4. URL Parameters (Optional)

• Add any URL parameters to include in the request

• Examples:

  • page=1

  • limit=100

  • category=electronics

• Format: One parameter per line

• These will be added to your API URL automatically

5. Body (Optional)

• Add request body content if needed (for POST requests)

• Usually in JSON format

• Example: {"key": "value"}

• Leave empty for GET requests

6. Timeout

• Set how long to wait for the API response

• Default appears to be in milliseconds

• Adjust based on your API's expected response time

• Higher values for slower APIs

7. Chunk Size

• Set how many tokens or characters should be in each chunk

• Default value is 1024 (recommended for most cases)

• This controls how the API response data is divided for processing

8. Select Embedding Model

• Default "OpenAI - Text Embedding 3 Small" is already selected

• You can change this by clicking the dropdown if needed

• This model processes and understands your API data

9. Review Cost Warning

• ⚠️ Important: Check the yellow warning box

• Data import costs 0.035 tokens per word

• Consider the size of your API responses

10. Final Step

• Click the "Save" button at the bottom

• The system will call your REST API and process the response

• The data will be ready for AI to work with

Key Features:

• Live Data: Connects to real-time API data

• Flexible Configuration: Supports headers, parameters, and request bodies

• Automatic Processing: Converts API responses into searchable text

Common Use Cases:

• Product catalogs from e-commerce APIs

• Customer data from CRM systems

• Weather or financial data from public APIs

• Internal company APIs

• Third-party service integrations

Simple Summary:

1. Give your API connection a name

2. Enter the API URL

3. Add authentication headers if needed (optional)

4. Add URL parameters if needed (optional)

5. Set timeout and other settings (or keep defaults)

6. Click Save

7. Done!

The system will fetch data from your REST API and convert it into text that AI can understand and work with for analysis and questions!