--- title: "Configure Agent-Based API" slug: "configure-agent-based-api" updated: 2026-05-21T10:33:20Z published: 2026-05-21T10:33:20Z canonical: "help.symphonysummitai.com/configure-agent-based-api" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt > Use this file to discover all available pages before exploring further. # Configure Agent-Based API Agent-based API configuration enables the system to fetch discovered device data from the tables. > [!NOTE] > Note > > - The API is used to pull discovered data from the application tables. > - It is later consumed by a scheduler job for periodic data sync. To configure agent-based API, perform the following steps: 1. Log in to the application as an Application Designer. 2. Navigate to **Settings** > **Design Studio** > **Discovery Module** > **API Configuration**. 3. Click **New** to configure a new API. API Configuration page is displayed. For more information refer to the following: [API Configuration Details](/summit-platform/docs/configure-agent-based-api#api-configuration-details) [API Details](/summit-platform/docs/configure-agent-based-api#configure-api-details) [Other API Details](/summit-platform/docs/configure-agent-based-api#other-api-details) ## API Configuration Details Enter the required details in API Configuration . For more information, refer to the following [Field Description](/summit-platform/docs/configure-agent-based-api#field-description). ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/field config(1).png?sv=2026-02-06&spr=https&st=2026-11-17T01%3A13%3A02Z&se=2026-11-17T02%3A13%3A02Z&sr=b&sp=r&sig=OB3WQPWuuwXKx8uEd4N%2FmdWJJbG8TC9a7jODR24k4yE%3D)Figure: API Configuration ### Field Description | Field | Description | | --- | --- | | API Config Name | Enter **AgentBase Discovery Sync**, this indicates the configuration is used to **synchronize discovery data from agent-based sources** into the system. | | API Group Name | Select **Others**, the API is categorized under a general/default group, meaning it is not grouped under any specific predefined category. | | Configured For | Select **Inbound**, shows that this API is used to **receive data into the application** (data is pulled from tables into the system). | | Domain | Select **Domain**, specifies the domain to which the API configuration belongs. This helps segregate configurations across different organizational domains. | | Sub-Domain | Select **Sub-Domain**, further categorizes the API under a specific sub-domain within the selected domain for finer classification. | | Department | Select **Department**, identifies the department responsible for or associated with the API configuration. This is useful for ownership and access control. | | Active | Enable **Active**, the API configuration is currently active and available for use in schedulers or integrations. | | Icon | Upload an **Icon**, a visual identifier is optionally added. | ## Configure API Details Enter the details in API Details section. For more information, refer to the following [Field Description](/summit-platform/docs/configure-agent-based-api#field-description1). ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/api det.png?sv=2026-02-06&spr=https&st=2026-11-17T01%3A13%3A02Z&se=2026-11-17T02%3A13%3A02Z&sr=b&sp=r&sig=iJZM9%2FfRBKANrgGUZGY%2ByXPka3cfo5dvFz95BCz4xy0%3D) Figure: API Details ### Field Description | Field | Description | | --- | --- | | API Name | Specifies the name of the API used to retrieve device details from the tables. In this use case, it represents the API responsible for fetching table data into the system. | | API Timeout (in seconds) | Defines the maximum time the system waits for a response when calling the agent-based API. For discovery sync, this ensures the data retrieval process does not hang indefinitely if the agent does not respond. | | API Type | Indicates that the API is *Internal*, meaning it is used within the application ecosystem to process and sync table data rather than connecting to an external third-party service. | | Response Type | Specifies the expected structure of the API response. In this case, *Array* indicates that multiple device records are returned from the table in a list format. | | List the Response Attributes with Hierarchy | When enabled, the device data from the table (which may include nested attributes like hardware details) is displayed in a hierarchical structure. This is useful for mapping complex discovery data. | | Method | Used to configure how the system authenticates API requests when retrieving table data. Ensures secure communication between the system and the agent endpoint. | | URL | Specifies the endpoint used to fetch device data from the table. In this use case, it represents the internal API endpoint that retrieves static or discovered device data (hardware tables) for further processing in discovery. The URL is instance-specific and must be configured based on the environment (for example, tenant URL), ensuring the scheduler can successfully call the API and pull table data. | | Authentication | Defines the authentication mechanism used. In this case, *API Key* is used to authorize requests for accessing table data. | | Params | Allows defining query parameters required to filter or control the data fetched from the tables (example: device type, timestamp, or batch details if applicable). | | Headers | Used to configure request headers required for the agent API, such as authentication headers or content type. | | Body | Used to pass additional input data if the API requires it. In this scenario (table data retrieval), it is typically minimal or not used depending on API design. | | Response | Used to view and map the response fields returned from the agent API to the system’s discovery or hardware tables for further processing. | ## Other API Details - [Authentication](/summit-platform/docs/configure-agent-based-api#authentication) - [Body](/summit-platform/docs/configure-agent-based-api#body) ### Authentication Enter the required details in the Authentication fields. Fore more information, refer the following [Field Description](/summit-platform/docs/configure-agent-based-api#field-description2): ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/auth.png?sv=2026-02-06&spr=https&st=2026-11-17T01%3A13%3A02Z&se=2026-11-17T02%3A13%3A02Z&sr=b&sp=r&sig=HisSgTxoFypruEP4TKdi7XkBGXOjhcKYZyYDPK2C07Y%3D) Figure: Authentication #### Field Description | Field | Description | | --- | --- | | Authentication Type | Specifies the authentication mechanism used to access the API. In this use case, **API Key** is selected to securely authenticate requests made to fetch agent-based discovery data. | | Key | Defines the header name used to pass the authentication credential in the API request. In this scenario, `X-API-KEY` is used to send the API key as part of the request header. | | Value | Represents the actual API key required to authorize access to the API endpoint. This value ensures that only authenticated requests can retrieve table data from the system. | ### Body Enter the **API** payload details in the **Body** section. For more information, refer to the Request Parameters section. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/api payl.png?sv=2026-02-06&spr=https&st=2026-11-17T01%3A13%3A02Z&se=2026-11-17T02%3A13%3A02Z&sr=b&sp=r&sig=%2FBbbAS%2FaaPQZroEzioL1jhuV4bM6aVP7v4Hodbrj9Bw%3D)Figure: API Payload ### **Request Parameters** | Field Name | Type | Required | Description | | --- | --- | --- | --- | | tableUniqueId | **String** | Yes | Unique identifier of the source table from which device data is retrieved. In this use case, it represents the hardware data table used for discovery sync. | | filters | **Array** | No | Defines filtering conditions to restrict the data fetched from the table. Used to ensure only table records are retrieved. | | filters[].columnName | **String** | Yes (if filters used) | Specifies the column name on which the filter is applied. In this case, it filters based on the data source column. | | filters[].value | **String** | Yes (if filters used) | Specifies the value to match for the given column. Here, it ensures only records with Data Source = tables are fetched. |