Interface ExecuteAiApiResponse

Response from executing an AI-powered API request. Includes the AI-generated answer and details of executed API calls.

interface ExecuteAiApiResponse {
    answer: string;
    executedApis?: AiApiResult[];
    explanation?: string;
    queryMarkdownType?: string;
    success: boolean;
}

Properties

answer: string

AI-generated answer for the API request.

executedApis?: AiApiResult[]

List of executed API requests and their results.

explanation?: string

Optional explanation for the AI-generated API response.

queryMarkdownType?: string

Markdown format type of the executed query response.

success: boolean

Indicates whether the API request execution was successful.