AutoBE
    Preparing search index...

    Interface AutoBeInterfaceEndpointReviewEvent

    Event fired during the review and validation phase of API endpoint definitions.

    This event occurs when the Interface agent is reviewing and validating the generated API endpoints against business requirements, technical specifications, and REST API design principles. The review phase ensures that each endpoint properly follows RESTful conventions with correct paths, HTTP methods, and adherence to API design best practices.

    The review process involves systematic validation where the agent evaluates endpoint naming consistency, path structure correctness, HTTP method appropriateness, and overall API design patterns. Endpoints that fail validation are marked for revision to ensure the final API specification maintains consistent and intuitive REST API structure.

    Kakasoo

    interface AutoBeInterfaceEndpointReviewEvent {
        completed: number;
        created_at: string & Format<"date-time">;
        designs: AutoBeInterfaceEndpointDesign[];
        group: string;
        id: string;
        kind: "base" | "action";
        metric: AutoBeFunctionCallingMetric;
        review: string;
        revises: AutoBeInterfaceEndpointRevise[];
        step: number;
        tokenUsage: IComponent;
        total: number;
        type: "interfaceEndpointReview";
    }

    Hierarchy (View Summary)

    Index

    Properties

    completed: number

    Number of items completed.

    Tracks how many items have been successfully processed so far in the current operation. This value increments as each item is completed, providing real-time progress indication.

    The ratio of completed to total gives the completion percentage: progress = (completed / total) * 100

    created_at: string & Format<"date-time">

    Timestamp when the event was created.

    ISO 8601 formatted date-time string indicating when this event was emitted by the system. This timestamp is crucial for event ordering, performance analysis, and debugging the agent workflow execution timeline.

    Format: "YYYY-MM-DDTHH:mm:ss.sssZ" (e.g., "2024-01-15T14:30:45.123Z")

    Original API endpoints submitted for review.

    The complete set of endpoints generated by the Interface Endpoints Agent that require validation for RESTful compliance, naming consistency, path structure correctness, and adherence to AutoBE standards. These are the endpoints being evaluated for potential issues and improvements.

    group: string
    id: string

    A unique identifier for the event.

    kind: "base" | "action"

    Type discriminator for the endpoint review event.

    Specifies which type of endpoints are being reviewed:

    • "base": Base CRUD endpoints (at, index, create, update, erase)
    • "action": Action endpoints (analytics, dashboard, search, reports)

    Function calling trial statistics for the operation.

    Records the complete trial history of function calling attempts, tracking total executions, successful completions, consent requests, validation failures, and invalid JSON responses. These metrics reveal the reliability and quality of AI agent autonomous operation with tool usage.

    Trial statistics are critical for identifying operations where agents struggle with tool interfaces, generate invalid outputs, or require multiple correction attempts through self-healing spiral loops. High failure rates indicate opportunities for system prompt optimization or tool interface improvements.

    review: string

    Summary of issues found and fixes applied during review.

    Documents all issues discovered during endpoint validation including duplicates, inconsistencies, design issues, and what patterns or conventions were violated. States "No issues found." if all endpoints pass review.

    step: number

    Current iteration number of the endpoint review process.

    Indicates which revision cycle of the API endpoint review is currently being executed. This step number helps track the iterative validation process and provides context for understanding how many review cycles have been completed to achieve the desired endpoint quality.

    The step value increments with each major review iteration, allowing stakeholders to monitor the progressive refinement of API endpoints and understand the validation rigor applied to the interface design.

    tokenUsage: IComponent

    Detailed token usage metrics for the operation.

    Contains comprehensive token consumption data including total usage, input token breakdown with cache hit rates, and output token categorization by generation type (reasoning, predictions). This component-level tracking enables precise cost analysis and identification of operations that benefit most from prompt caching or require optimization.

    Token usage directly translates to operational costs, making this metric essential for understanding the financial implications of different operation types and guiding resource allocation decisions.

    total: number

    Total number of items to process.

    Represents the complete count of operations, files, endpoints, or other entities that need to be processed in the current workflow step. This value is typically determined at the beginning of an operation and remains constant throughout the process.

    Used together with the completed field to calculate progress percentage and estimate time to completion.

    type: "interfaceEndpointReview"

    Unique identifier for the event type.

    A literal string that discriminates between different event types in the AutoBE system. This field enables TypeScript's discriminated union feature, allowing type-safe event handling through switch statements or conditional checks.

    Examples: "analyzeWrite", "databaseSchema", "interfaceOperation", "testScenario"