bidDeskAiUsage

Requires permission biddesk:settings:manage.

This month's Bid Desk AI pool, what has been used and what remains, a forecast to month end, the governor's state, and the use by feature, model, agent and bid. Bids the reader may not see are summed into a CONFIDENTIAL row without a title. Requires Bid Desk and permission to manage Bid Desk settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BidDeskAiUsage {
  bidDeskAiUsage {
    forecastCents
    periodEnd
    periodStart
    remainingCents
    totalLoggedCents
    unattributedCents
    byAgent {
      creditsCents
      key
      runs
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDeskAiUsage {\n  bidDeskAiUsage {\n    forecastCents\n    periodEnd\n    periodStart\n    remainingCents\n    totalLoggedCents\n    unattributedCents\n    byAgent {\n      creditsCents\n      key\n      runs\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidDeskAiUsage": {
      "forecastCents": 0,
      "periodEnd": "2025-01-15T00:00:00Z",
      "periodStart": "2025-01-15T00:00:00Z",
      "remainingCents": 0,
      "totalLoggedCents": "string",
      "unattributedCents": "string",
      "byAgent": [
        {
          "creditsCents": "string",
          "key": "string",
          "runs": 0
        }
      ]
    }
  }
}

bidDeskAiUsage: BidDeskAiUsage!

Type

BidDeskAiUsage object

The month's Bid Desk AI pool, what has been used, and what used it. Every figure ties back to the usage log the governor enforces.