Agents

Get agent usage

GET /v1/agents/{agent_id}/metrics

Permission: read:configs
Tokens: API key, CLI user token, Sandbox token

Read usage and spend windows for an agent.

Path parameters

agent_idstringrequired

{

}

import os

from ellipsis import Ellipsis

client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])

result = client.agents.metrics("check-tests")
print(result)

import { Ellipsis } from '@ellipsis-dev/sdk';

const client = new Ellipsis({
  apiKey: process.env.ELLIPSIS_API_TOKEN!,
});

const result = await client.agents.metrics("check-tests");
console.log(result);

curl "https://api.ellipsis.dev/v1/agents/{agent_id}/metrics" \
  -H "Authorization: Bearer $ELLIPSIS_API_TOKEN"

Response

samplesarray<AgentSessionSample>required

One entry per finished session, unordered.

spend_windowsarray<ConfigSpendWindow>required

Trailing spend versus the budget, one entry per window (1, 7, and 28 days).

Get agent usage

Path parameters

Response

On this page