Skip to content
General Augment Docs

Show Usage

GET
/api/v3/projects/{project_id}/usage
curl --request GET \
  --url 'https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage?target=all'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
start
Any of:
string format: date
end
Any of:
string format: date
target
Target
string
default: all /^(candidate|live|all)$/

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
UsageSummaryResponseV3
object
credit_balance_usd
required
Credit Balance Usd
number
daily
Daily
Array<object>
UsageDailyResponseV3
object
agent_turns
required
Agent Turns
integer
api_calls
required
Api Calls
integer
channel_cost_usd
required
Channel Cost Usd
number
channel_messages
required
Channel Messages
integer
date
required
Date
string format: date
input_tokens
required
Input Tokens
integer
llm_cost_usd
required
Llm Cost Usd
number
messages
required
Messages
integer
output_tokens
required
Output Tokens
integer
target
required
Target
string
Allowed values: candidate live
tool_calls
required
Tool Calls
integer
total_cost_usd
required
Total Cost Usd
number
end
required
End
string format: date
project_id
required
Project Id
string format: uuid
start
required
Start
string format: date
target
required
Target
string
Allowed values: candidate live all
totals
required
Totals
object
key
additional properties
Any of:
integer
Example
{
  "daily": [
    {
      "target": "candidate"
    }
  ],
  "target": "candidate"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}