Documentation Index
Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt
Use this file to discover all available pages before exploring further.
Usage API
Get usage statistics and analytics for your account or workspace.
Get User Usage
Get usage statistics for the authenticated user.
Query Parameters
| Parameter | Type | Description |
|---|
startDate | string | Start date (ISO 8601) |
endDate | string | End date (ISO 8601) |
receptorId | string | Filter by receptor UUID |
Example Request
const usage = await auvy.usage.getUserUsage({
startDate: new Date('2024-01-01'),
endDate: new Date('2024-01-31')
})
curl "https://api.auvy.ai/v1/usage?startDate=2024-01-01&endDate=2024-01-31" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"totalTokens": 150000,
"totalCost": 12.50,
"usageByProvider": {
"openai": {
"tokens": 100000,
"cost": 8.00
},
"anthropic": {
"tokens": 50000,
"cost": 4.50
}
},
"usageByModel": {
"gpt-5.4": {
"tokens": 80000,
"cost": 6.40
},
"claude-3-opus": {
"tokens": 50000,
"cost": 4.50
}
},
"usageByResource": {
"receptor": {
"rec-id": {
"resourceId": "rec-id",
"slug": "my-receptor",
"subtype": "completion",
"tokens": 75000,
"cost": 6.25,
"invokeCount": 42,
"inputTokens": 40000,
"outputTokens": 35000,
"cachedInputTokens": 0
}
},
"neuron": {},
"pathway": {}
},
"usageRollupIntegrity": {
"totalTokens": 150000,
"totalCost": 12.5,
"providerFacetTokenSum": 150000,
"modelFacetTokenSum": 150000,
"receptorFacetTokenSum": 150000,
"neuronFacetTokenSum": 150000,
"pathwayFacetTokenSum": 150000,
"providerFacetCostSum": 12.5,
"modelFacetCostSum": 12.5,
"receptorFacetCostSum": 12.5,
"neuronFacetCostSum": 12.5,
"pathwayFacetCostSum": 12.5,
"allFacetsMatchTotals": true
}
}
Get Workspace Usage
Get usage statistics for a workspace (admin only).
GET /v1/usage/:workspace_id
Path Parameters
| Parameter | Type | Description |
|---|
workspace_id | string | Workspace UUID |
Query Parameters
| Parameter | Type | Description |
|---|
startDate | string | Start date (ISO 8601) |
endDate | string | End date (ISO 8601) |
receptorId | string | Filter by receptor UUID |
Example Request
const usage = await auvy.usage.getWorkspaceUsage('workspace-uuid', {
startDate: new Date('2024-01-01')
})
curl "https://api.auvy.ai/v1/usage/workspace-uuid?startDate=2024-01-01" \
-H "Authorization: Bearer YOUR_API_KEY"
Usage Statistics Schema
Provider Statistics
{
tokens: number
cost: number
}
Model Statistics
{
tokens: number
cost: number
}
Receptor Statistics
{
receptorId: string
receptorSlug?: string
receptorType?: string
tokens: number
cost: number
invokeCount: number
}
Get Receptor Usage Ranking
Get usage per receptor sorted by tokens, cost, or invoke count (admin only).
GET /v1/usage/:workspace_id/receptors
Path Parameters
| Parameter | Type | Description |
|---|
workspace_id | string | Workspace UUID |
Query Parameters
| Parameter | Type | Description |
|---|
startDate | string | Start date (ISO 8601) |
endDate | string | End date (ISO 8601) |
sortBy | string | Sort by tokens, cost, or invokeCount (default: tokens) |
Example Request
const ranking = await auvy.usage.getWorkspaceReceptorRanking('workspace-uuid', {
sortBy: 'invokeCount'
})
curl "https://api.auvy.ai/v1/usage/workspace-uuid/receptors?sortBy=invokeCount" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"workspaceId": "workspace-uuid",
"sortBy": "invokeCount",
"receptors": [
{
"receptorId": "receptor-uuid",
"receptorSlug": "my-receptor",
"receptorType": "completion",
"tokens": 75000,
"cost": 6.25,
"invokeCount": 42
}
]
}