Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
API Reference
Agents

Get Agent Usage

agents.retrieve_usage(struuid, AgentRetrieveUsageParams**kwargs) -> AgentRetrieveUsageResponse
get/v2/gen-ai/agents/{uuid}/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.

ParametersExpand Collapse
uuid: str
start: Optional[str]

Return all usage data from this date.

stop: Optional[str]

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

ReturnsExpand Collapse
class AgentRetrieveUsageResponse: …

Agent usage

log_insights_usage: Optional[LogInsightsUsage]

Resource Usage Description

measurements: Optional[List[LogInsightsUsageMeasurement]]
tokens: Optional[int]
formatint64
usage_type: Optional[str]
resource_uuid: Optional[str]
start: Optional[datetime]
formatdate-time
stop: Optional[datetime]
formatdate-time
usage: Optional[Usage]

Resource Usage Description

measurements: Optional[List[UsageMeasurement]]
tokens: Optional[int]
formatint64
usage_type: Optional[str]
resource_uuid: Optional[str]
start: Optional[datetime]
formatdate-time
stop: Optional[datetime]
formatdate-time
Get Agent Usage
from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
response = client.agents.retrieve_usage(
    uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(response.log_insights_usage)
{
  "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"
  }
}
Returns Examples
{
  "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"
  }
}