@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface UsageRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/agents/{agent_uu-id}/usage

    interface UsageRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                UsageRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiGetAgentUsageOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                UsageRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        withUrl(rawUrl: string): UsageRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get toGetRequestInformation withUrl

    Methods

    • To get agent usage, send a GET request to /v2/gen-ai/agents/{uuid}/usage. Returns usage metrics for the specified agent within the provided time range.

      Parameters

      Returns Promise<undefined | ApiGetAgentUsageOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • Parameters

      • rawUrl: string

      Returns UsageRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods