Sign in
DigitalOcean-public.v2-new_GradientAI Platform

Get Agent Usage

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.

get/v2/gen-ai/agents/{uuid}/usage

Path parameters

uuidstring required

Agent id

Query parameters

startstring

Return all usage data from this date.

stopstring

Return all usage data up to this date, if omitted, will return up to the current date.

Response

A successful response.

Example response

{
  "log_insights_usage": {
    "measurements": [
      {
        "tokens": 123,
        "usage_type": "example string"
      }
    ],
    "resource_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "start": "2023-01-01T00:00:00Z",
    "stop": "2023-01-01T00:00:00Z"
  },
  "usage": {
    "measurements": [
      {
        "tokens": 123,
        "usage_type": "example string"
      }
    ],
    "resource_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "start": "2023-01-01T00:00:00Z",
    "stop": "2023-01-01T00:00:00Z"
  }
}

Changes

Changed in 2 of the 8 revisions of this API.3