Usage Metrics API

Check the usage metrics of your LLMWhisperer account.

Endpoint	/get-usage-info
URL	https://llmwhisperer-api.us-central.unstract.com/api/v2/get-usage-info
Method	GET
Headers	unstract-key: <YOUR API KEY>

Parameters

None

Example Curl Request

curl -X GET --location 'https://llmwhisperer-api.us-central.unstract.com/api/v2/get-usage-info' \
-H 'unstract-key: <Your API Key>'

info

To include the headers in the response use curl -i in the request.

Response

HTTP Status	Content-Type	Headers	Description
200	application/json		The API will return a JSON with the usage metrics. Refer below for JSON format

For Paid Plans

{
    "subscription_plan": "<Plan Name>",
    "monthly_quota": <Monthly Quota>,
    "current_page_count": <Current Page Count>,
    "current_page_count_native_text": <For Native Text Mode>,
    "current_page_count_low_cost": <For Low Cost Mode>,
    "current_page_count_high_quality": <For High Quality Mode>,
    "current_page_count_form": <For Form Mode>,
    "daily_quota": -1,
    "overage_page_count": <Overage Page Count>,
    "today_page_count": <Page Count For Day>,
}

daily_quota will be -1 for paid plans. There is no daily quota for paid plans.

For Free Plan

{
    "subscription_plan": "<Plan Name>",
    "daily_quota": <Daily Quota>,
    "today_page_count": <Page Count For Day>,
    "monthly_quota": -1,
    "current_page_count": -1,
    "overage_page_count": -1,
}

Fields marked -1 for free plans indicate that there's no quota or it doesn't apply to these plans.