Informat AI Low-Code Docs

English

简体中文

English

简体中文

Appearance

AI API Agent ​

Overview ​

The AI API Agent assists users in designing, configuring, validating, and managing application APIs, covering API path definitions, script invocations, pre/post-processing logic, rate limiting, and security policies, ensuring APIs have completeness and executability after creation or update.

Core Capabilities ​

1. API Design and Configuration ​

  • Path Definition: Design RESTful-style API paths and HTTP methods
  • Script Binding: Associate APIs with execution scripts, supporting pre-processing, main logic, post-processing, and exception handling
  • Parameter Design: Define request parameters, response formats, and return types

2. API Validation ​

  • Path Uniqueness Check: Ensure API paths don't conflict
  • Script Integrity Validation: Verify that referenced scripts and functions actually exist and are executable
  • Execution Chain Validation: Check the completeness of the before → main → after / error processing chain
  • Rate Limit Configuration Validation: Verify the legality of rate limiting parameters

3. Security Policy Guidance ​

  • Authentication Method Design: Help users choose appropriate API authentication schemes
  • Rate Limiting Strategy Configuration: Design reasonable API call frequency limits
  • Exception Handling: Configure error handling logic for API execution exceptions

Using the AI API Agent ​

In the [Application Designer]'s [AI] module, click [API Agent] to switch to the API agent conversation.

Application Cases ​

1. Create Data Query API ​

  • Use Case: Need to provide an external interface for querying data table records
  • Example: Input "Help me create an API for querying a list of records from a data table"

2. Design Complete API Solution ​

  • Use Case: Need to design a complete API calling solution
  • Example: Input "How to call data in Informat through API?"

Important Notes ​

  • When using script capabilities for APIs, script files and functions must be created first before being referenced in the API
  • It is strictly prohibited to fill in scriptId or scriptFunc before the script is created
  • After creating or updating an API, the agent will automatically perform a complete validation
  • APIs will not be considered valid results until validation passes