Feedloop AI
  • GETTING STARTED
    • Discover Feedloop AI
    • Authentication
      • Sign Up
      • Login
    • Platform
      • Workspace
      • Project
      • People
      • Usage
  • WHAT IS AGENT
    • What is Agent
      • ⚪Manage Agent
    • Basic Agent
      • ⚪Instruction
        • Who
        • What
      • ⚪Training
        • Rules
        • Example
      • ⚪Skill
        • Knowledge
        • Analys
      • ⚪Style
    • Procedures
    • Advance Reasoning
      • ⚪Creating New Agent
      • ⚪Advance Agent Activation
      • ⚪Deleting Agent
      • ⚪Advance Agent Managing Existing
  • AGENT SETTINGS
    • Instruction
      • Who
      • What
      • Additional Instruction
    • Training
      • Chat Rules
      • Retrieval
      • Answering
    • Context
      • Primitive Context
      • Array
    • Tools
      • Knowledge
      • API - Call
        • Manage API Call
        • Basic Configuration
        • Header
        • Body Field
          • Input Binding
            • Page 2
          • Output Binding
        • Testing API Call
        • Trouble Shooting
        • Example Implementation
          • API Call Covid
      • Data Connector
    • Card
      • Intro & Summary Text
      • Data Visualization Card
      • Analyze Card
    • Procedure Basic Info
      • Activation Condition
      • Goal
      • Action
    • Procedures Interaction
      • Procedures Step
      • Procedures Context
      • Procedures Tools
  • AGENT UTILITY
    • Resource
      • Document PDF
        • Preparing your PDF
      • Data Connector
        • Create new data connector
        • Configure dataset, table, and column
        • Using Data Playground
        • Dataset in Data Playground
        • Training in Data Playground
        • SQL generation and modification
        • SQL Execution
    • Apps
      • Chat Widget
      • Web App
    • Testing
    • Monitoring
      • Customer Chat
      • Context
      • Document
  • TASK
    • ⚪Image Analyzer
      • Building Analyzer
      • ID Identifier
    • ⚪Document Analyzer
      • Contractual Document Analyzer
    • ⚪Database Analyzer
    • ⚪Additional Solution
      • Text Sentiment Analyzer
      • Customer Complaint Analyzer
  • For Developer
    • API Chat
      • Chat Initialization
      • Chat Message
      • Chat History
      • Error Handling
    • Embed Widget
      • Embedding the Widget
      • Identity Attributes
      • Widget Attribute Details
Powered by GitBook
On this page
  • Configuring Basic Configuration of API Call
  • Description
  • Condition
  • URL
  • Method
  • Next - Header (Key-Value Pairs)
  1. AGENT SETTINGS
  2. Tools
  3. API - Call

Basic Configuration

PreviousManage API CallNextHeader

Last updated 7 months ago

Configuring Basic Configuration of API Call

Description

  • Field Purpose: This field allows you to define a short and clear description of the API request. The description helps others understand the purpose of the API call and its function within the system.

  • How to Configure:

    • Provide a brief description that explains the action this API call will perform.

    • Example: “Retrieve customer details based on the provided user ID.”

Condition

  • Field Purpose: Here, you describe the conditions or triggers that will cause the API call to be executed. This could be based on user actions, specific events, or data from the conversation.

  • How to Configure:

    • Define the condition that must be met for the API call to occur.

    • Example: “When the user submits their user ID, this API call will fetch their account details.”

URL

  • Field Purpose: The URL field is used to define the endpoint of the API you want to connect with. This is where the system will send the request to retrieve or send data.

  • How to Configure:

    • Enter the full API URL (including parameters if necessary).

    • Example: “https://api.example.com/v1/customer/details?userID=123”

Method

  • Field Purpose: This setting specifies the HTTP method used for the API call. In this case, the API is exclusively used to retrieve data, and the only available method is GET.

  • Available Method:

    • GET – Used exclusively to retrieve data from external sources.

  • How to Configure:

    • Since this API is designed solely for data retrieval, the GET method is preselected and must be used for all API calls. No other HTTP methods (e.g., POST, PUT, DELETE) are allowed in this configuration.

  • Example:

    • For retrieving customer details or product information, the GET method will be used to fetch the necessary data from the external API.

Next - Header (Key-Value Pairs)

Header
API basic configuration - Description
API Basic Configuration - Condition
API Basic Configuration - URL