Interface AiAgentApiIntegrationOptions

Configuration options for AI agent API integration.

interface AiAgentApiIntegrationOptions {
    generateApiCallAgentId?: string;
    operationsToUse?: string[];
    verboseStatusUpdates?: boolean;
}

Properties

generateApiCallAgentId?: string

If provided, this agent will be used to generate API calls.

operationsToUse?: string[]

A list of API operation IDs (endpoint IDs) that the AI agent can call.

When this list is not provided (i.e., it is undefined) or is empty, the AI agent has access to all operations.

verboseStatusUpdates?: boolean

If true, provides more detailed status updates during API call execution. Default: false.