Usage

Inspect current API usage without spending primary request quota

Returns the authenticated caller sliding-window request budget and UTC-day usage. This endpoint is authenticated and does not increment the primary Redis rate-limit counter or log itself into the API usage table; it is separately throttled at 100 reads/minute per user to protect the usage-count query.

get/api/v1/usage

Response

Usage budget and counters for the authenticated API key owner.

object'usage' required

Example response

{
  "data": {
    "rate_limit": {
      "used": 7,
      "limit": 100,
      "remaining": 93,
      "reset_at": 1710772860,
      "window_seconds": 60
    },
    "daily_usage": {
      "used": 42,
      "reset_at": 1710806400,
      "window_seconds": 86400
    }
  }
}

Changes

Changed in 7 of the 31 revisions of this API.116111

    • added the new database_unavailable enum value to the error/reason response property for the response status 401

      response-property-enum-value-added

    • added the new database_unavailable enum value to the error/reason response property for the response status 402

      response-property-enum-value-added

    • added the new database_unavailable enum value to the error/reason response property for the response status 403

      response-property-enum-value-added

    • added the new database_unavailable enum value to the error/reason response property for the response status 423

      response-property-enum-value-added

    • added the new database_unavailable enum value to the error/reason response property for the response status 429

      response-property-enum-value-added

    • added the new database_unavailable enum value to the error/reason response property for the response status 503

      response-property-enum-value-added

    • added the optional property meta/ranking_as_of to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 401 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 401 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 503 status

      response-optional-property-added

  • 19193b1771541067See the full diff
    • added the new idempotency_in_progress enum value to the error/reason response property for the response status 402

      response-property-enum-value-added

    • added the new idempotency_in_progress enum value to the error/reason response property for the response status 403

      response-property-enum-value-added

    • added the new idempotency_in_progress enum value to the error/reason response property for the response status 423

      response-property-enum-value-added

    • added the new idempotency_in_progress enum value to the error/reason response property for the response status 429

      response-property-enum-value-added

    • added the new idempotency_in_progress enum value to the error/reason response property for the response status 503

      response-property-enum-value-added

    • added the new webhook_delivery_in_progress enum value to the error/reason response property for the response status 402

      response-property-enum-value-added

    • added the new webhook_delivery_in_progress enum value to the error/reason response property for the response status 403

      response-property-enum-value-added

    • added the new webhook_delivery_in_progress enum value to the error/reason response property for the response status 423

      response-property-enum-value-added

    • added the new webhook_delivery_in_progress enum value to the error/reason response property for the response status 429

      response-property-enum-value-added

    • added the new webhook_delivery_in_progress enum value to the error/reason response property for the response status 503

      response-property-enum-value-added

    • added the media type application/json for the response with the status 401

      response-media-type-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 503 status

      response-optional-property-added

    • added the optional property error/reason to the response with the 402 status

      response-optional-property-added

    • added the optional property error/reason to the response with the 403 status

      response-optional-property-added

    • added the optional property error/reason to the response with the 423 status

      response-optional-property-added

    • added the optional property error/reason to the response with the 429 status

      response-optional-property-added

    • added the optional property error/reason to the response with the 503 status

      response-optional-property-added

    • added the optional property error/retry_at to the response with the 402 status

      response-optional-property-added

    • added the optional property error/retry_at to the response with the 403 status

      response-optional-property-added

    • added the optional property error/retry_at to the response with the 423 status

      response-optional-property-added

    • added the optional property error/retry_at to the response with the 429 status

      response-optional-property-added

    • added the optional property error/retry_at to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 503 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 402 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 403 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 423 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 503 status

      response-optional-property-added

    • added the required property meta/cost to the response with the 200 status

      response-required-property-added

    • added the required property meta/cost to the response with the 402 status

      response-required-property-added

    • added the required property meta/cost to the response with the 403 status

      response-required-property-added

    • added the required property meta/cost to the response with the 423 status

      response-required-property-added

    • added the required property meta/cost to the response with the 429 status

      response-required-property-added

    • added the required property meta/cost to the response with the 503 status

      response-required-property-added

    • removed the media type application/json for the response with the status 401

      response-media-type-removed

    • added the media type application/json for the response with the status 401

      response-media-type-added

    • endpoint added

      endpoint-added