Interface components

interface components {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: never;
    schemas: {
        CustomerUsageResponse: {
            customerId: string;
            totalCostCents: number;
            totalEvents: number;
            totalInputTokens: number;
            totalOutputTokens: number;
            totalTokens: number;
        };
        ErrorResponse: { error: string };
        Event: {
            costCents?: number | null;
            createdAt: string;
            customerId: string;
            eventType: string;
            id: string;
            inputTokens?: number | null;
            latencyMs?: number | null;
            model?: string | null;
            outputTokens?: number | null;
            properties: { [key: string]: unknown };
            provider?: string | null;
            totalTokens?: number | null;
        };
        EventsBatchPostRequest: {
            events: {
                costCents?: number;
                customerId: string;
                eventType: string;
                idempotencyKey?: string;
                inputTokens?: number;
                latencyMs?: number;
                model?: string;
                outputTokens?: number;
                properties?: { [key: string]: unknown };
                provider?: string;
                timestamp?: string;
                totalTokens?: number;
            }[];
        };
        EventsBatchPostResponse: { count: number };
        EventsPostRequest: {
            costCents?: number;
            customerId: string;
            eventType: string;
            idempotencyKey?: string;
            inputTokens?: number;
            latencyMs?: number;
            model?: string;
            outputTokens?: number;
            properties?: { [key: string]: unknown };
            provider?: string;
            timestamp?: string;
            totalTokens?: number;
        };
        EventsPostResponse: { id: string };
        PaginationCursor: { hasMore: boolean; nextCursor: string | null };
        Project: {
            createdAt: string;
            id: string;
            name: string;
            organizationId: string;
            slug: string;
            updatedAt: string;
        };
        Quota: {
            createdAt: string;
            dimensionFilters: { [key: string]: unknown };
            id: string;
            limitValue: number;
            metric: string;
            name: string;
            period: string;
            projectId: string;
            updatedAt: string;
        };
        QuotaAlert: {
            createdAt: string;
            id: string;
            lastTriggeredAt?: string
            | null;
            quotaId: string;
            threshold: number;
            updatedAt: string;
        };
        QuotaAlertLog: {
            currentUsage: number;
            id: string;
            limitValue: number;
            percentage: number;
            quotaAlertId: string;
            quotaId: string;
            threshold: number;
            triggeredAt: string;
            webhookResponseCode: number
            | null;
            webhookStatus: string;
        };
        QuotaAlertsDeleteResponse: { success: boolean };
        QuotaAlertsPostRequest: { threshold: number };
        QuotaAlertsPutRequest: { threshold?: number };
        QuotaCheckResult: {
            exceeded: boolean;
            id: string;
            limit: number;
            metric: string;
            name: string;
            period: string;
            remaining: number;
            used: number;
        };
        QuotasCheckRequest: { [key: string]: unknown };
        QuotasCheckResponse: {
            allowed: boolean;
            quotas: {
                exceeded: boolean;
                id: string;
                limit: number;
                metric: string;
                name: string;
                period: string;
                remaining: number;
                used: number;
            }[];
        };
        QuotasDeleteResponse: { success: boolean };
        QuotasPostRequest: {
            dimensionFilters: { [key: string]: unknown };
            limitValue: number;
            metric: "total_tokens" | "total_events" | "total_cost_cents";
            name: string;
            period: "hour" | "day" | "week" | "month";
        };
        QuotasPutRequest: {
            dimensionFilters?: { [key: string]: unknown };
            limitValue?: number;
            metric?: "total_tokens" | "total_events" | "total_cost_cents";
            name?: string;
            period?: "hour" | "day" | "week" | "month";
        };
        QuotaStatus: {
            exceeded: boolean;
            id: string;
            limit: number;
            metric: string;
            name: string;
            period: string;
            remaining: number;
            reset: number;
            used: number;
        };
        RateLimit: {
            createdAt: string;
            dimensionFilters: { [key: string]: unknown };
            enabled: boolean;
            id: string;
            limitValue: number;
            name: string;
            projectId: string;
            updatedAt: string;
            window: string;
        };
        RateLimitCheckResult: {
            exceeded: boolean;
            id: string;
            limit: number;
            name: string;
            remaining: number;
            reset: number;
            window: string;
        };
        RateLimitsCheckRequest: { [key: string]: unknown };
        RateLimitsCheckResponse: {
            allowed: boolean;
            rateLimits: {
                exceeded: boolean;
                id: string;
                limit: number;
                name: string;
                remaining: number;
                reset: number;
                window: string;
            }[];
        };
        RateLimitsDeleteResponse: { success: boolean };
        RateLimitsPostRequest: {
            dimensionFilters: { [key: string]: unknown };
            enabled: boolean;
            limitValue: number;
            name: string;
            window: "hour" | "second" | "minute";
        };
        RateLimitsPutRequest: {
            dimensionFilters?: { [key: string]: unknown };
            enabled?: boolean;
            limitValue?: number;
            name?: string;
            window?: "hour" | "second" | "minute";
        };
        RateLimitStatus: {
            exceeded: boolean;
            id: string;
            limit: number;
            name: string;
            remaining: number;
            reset: number;
            window: string;
        };
        TrackPostErrorResponse: {
            allowed: boolean;
            error: string;
            quotas?: {
                exceeded: boolean;
                id: string;
                limit: number;
                metric: string;
                name: string;
                period: string;
                remaining: number;
                reset: number;
                used: number;
            }[];
            rateLimits?: {
                exceeded: boolean;
                id: string;
                limit: number;
                name: string;
                remaining: number;
                reset: number;
                window: string;
            }[];
        };
        TrackPostRequest: {
            costCents?: number;
            customerId: string;
            eventType: string;
            idempotencyKey?: string;
            inputTokens?: number;
            latencyMs?: number;
            model?: string;
            outputTokens?: number;
            properties?: { [key: string]: unknown };
            provider?: string;
            timestamp?: string;
            totalTokens?: number;
        };
        TrackPostResponse: {
            allowed: boolean;
            id: string;
            quotas: {
                exceeded: boolean;
                id: string;
                limit: number;
                metric: string;
                name: string;
                period: string;
                remaining: number;
                reset: number;
                used: number;
            }[];
            rateLimits: {
                exceeded: boolean;
                id: string;
                limit: number;
                name: string;
                remaining: number;
                reset: number;
                window: string;
            }[];
        };
        UsageBreakdownItem: {
            dimension?: string
            | null;
            totalCostCents: number;
            totalEvents: number;
            totalInputTokens: number;
            totalOutputTokens: number;
            totalTokens: number;
        };
        UsageBreakdownResponse: {
            data: {
                dimension?: string
                | null;
                totalCostCents: number;
                totalEvents: number;
                totalInputTokens: number;
                totalOutputTokens: number;
                totalTokens: number;
            }[];
        };
        UsageSummary: {
            totalCostCents: number;
            totalEvents: number;
            totalInputTokens: number;
            totalOutputTokens: number;
            totalTokens: number;
        };
        UsageTimeseriesItem: {
            timestamp: string;
            totalCostCents: number;
            totalEvents: number;
            totalInputTokens: number;
            totalOutputTokens: number;
            totalTokens: number;
        };
        UsageTimeseriesResponse: {
            data: {
                timestamp: string;
                totalCostCents: number;
                totalEvents: number;
                totalInputTokens: number;
                totalOutputTokens: number;
                totalTokens: number;
            }[];
        };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: never

schemas

schemas: {
    CustomerUsageResponse: {
        customerId: string;
        totalCostCents: number;
        totalEvents: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        totalTokens: number;
    };
    ErrorResponse: { error: string };
    Event: {
        costCents?: number | null;
        createdAt: string;
        customerId: string;
        eventType: string;
        id: string;
        inputTokens?: number | null;
        latencyMs?: number | null;
        model?: string | null;
        outputTokens?: number | null;
        properties: { [key: string]: unknown };
        provider?: string | null;
        totalTokens?: number | null;
    };
    EventsBatchPostRequest: {
        events: {
            costCents?: number;
            customerId: string;
            eventType: string;
            idempotencyKey?: string;
            inputTokens?: number;
            latencyMs?: number;
            model?: string;
            outputTokens?: number;
            properties?: { [key: string]: unknown };
            provider?: string;
            timestamp?: string;
            totalTokens?: number;
        }[];
    };
    EventsBatchPostResponse: { count: number };
    EventsPostRequest: {
        costCents?: number;
        customerId: string;
        eventType: string;
        idempotencyKey?: string;
        inputTokens?: number;
        latencyMs?: number;
        model?: string;
        outputTokens?: number;
        properties?: { [key: string]: unknown };
        provider?: string;
        timestamp?: string;
        totalTokens?: number;
    };
    EventsPostResponse: { id: string };
    PaginationCursor: { hasMore: boolean; nextCursor: string | null };
    Project: {
        createdAt: string;
        id: string;
        name: string;
        organizationId: string;
        slug: string;
        updatedAt: string;
    };
    Quota: {
        createdAt: string;
        dimensionFilters: { [key: string]: unknown };
        id: string;
        limitValue: number;
        metric: string;
        name: string;
        period: string;
        projectId: string;
        updatedAt: string;
    };
    QuotaAlert: {
        createdAt: string;
        id: string;
        lastTriggeredAt?: string
        | null;
        quotaId: string;
        threshold: number;
        updatedAt: string;
    };
    QuotaAlertLog: {
        currentUsage: number;
        id: string;
        limitValue: number;
        percentage: number;
        quotaAlertId: string;
        quotaId: string;
        threshold: number;
        triggeredAt: string;
        webhookResponseCode: number
        | null;
        webhookStatus: string;
    };
    QuotaAlertsDeleteResponse: { success: boolean };
    QuotaAlertsPostRequest: { threshold: number };
    QuotaAlertsPutRequest: { threshold?: number };
    QuotaCheckResult: {
        exceeded: boolean;
        id: string;
        limit: number;
        metric: string;
        name: string;
        period: string;
        remaining: number;
        used: number;
    };
    QuotasCheckRequest: { [key: string]: unknown };
    QuotasCheckResponse: {
        allowed: boolean;
        quotas: {
            exceeded: boolean;
            id: string;
            limit: number;
            metric: string;
            name: string;
            period: string;
            remaining: number;
            used: number;
        }[];
    };
    QuotasDeleteResponse: { success: boolean };
    QuotasPostRequest: {
        dimensionFilters: { [key: string]: unknown };
        limitValue: number;
        metric: "total_tokens" | "total_events" | "total_cost_cents";
        name: string;
        period: "hour" | "day" | "week" | "month";
    };
    QuotasPutRequest: {
        dimensionFilters?: { [key: string]: unknown };
        limitValue?: number;
        metric?: "total_tokens" | "total_events" | "total_cost_cents";
        name?: string;
        period?: "hour" | "day" | "week" | "month";
    };
    QuotaStatus: {
        exceeded: boolean;
        id: string;
        limit: number;
        metric: string;
        name: string;
        period: string;
        remaining: number;
        reset: number;
        used: number;
    };
    RateLimit: {
        createdAt: string;
        dimensionFilters: { [key: string]: unknown };
        enabled: boolean;
        id: string;
        limitValue: number;
        name: string;
        projectId: string;
        updatedAt: string;
        window: string;
    };
    RateLimitCheckResult: {
        exceeded: boolean;
        id: string;
        limit: number;
        name: string;
        remaining: number;
        reset: number;
        window: string;
    };
    RateLimitsCheckRequest: { [key: string]: unknown };
    RateLimitsCheckResponse: {
        allowed: boolean;
        rateLimits: {
            exceeded: boolean;
            id: string;
            limit: number;
            name: string;
            remaining: number;
            reset: number;
            window: string;
        }[];
    };
    RateLimitsDeleteResponse: { success: boolean };
    RateLimitsPostRequest: {
        dimensionFilters: { [key: string]: unknown };
        enabled: boolean;
        limitValue: number;
        name: string;
        window: "hour" | "second" | "minute";
    };
    RateLimitsPutRequest: {
        dimensionFilters?: { [key: string]: unknown };
        enabled?: boolean;
        limitValue?: number;
        name?: string;
        window?: "hour" | "second" | "minute";
    };
    RateLimitStatus: {
        exceeded: boolean;
        id: string;
        limit: number;
        name: string;
        remaining: number;
        reset: number;
        window: string;
    };
    TrackPostErrorResponse: {
        allowed: boolean;
        error: string;
        quotas?: {
            exceeded: boolean;
            id: string;
            limit: number;
            metric: string;
            name: string;
            period: string;
            remaining: number;
            reset: number;
            used: number;
        }[];
        rateLimits?: {
            exceeded: boolean;
            id: string;
            limit: number;
            name: string;
            remaining: number;
            reset: number;
            window: string;
        }[];
    };
    TrackPostRequest: {
        costCents?: number;
        customerId: string;
        eventType: string;
        idempotencyKey?: string;
        inputTokens?: number;
        latencyMs?: number;
        model?: string;
        outputTokens?: number;
        properties?: { [key: string]: unknown };
        provider?: string;
        timestamp?: string;
        totalTokens?: number;
    };
    TrackPostResponse: {
        allowed: boolean;
        id: string;
        quotas: {
            exceeded: boolean;
            id: string;
            limit: number;
            metric: string;
            name: string;
            period: string;
            remaining: number;
            reset: number;
            used: number;
        }[];
        rateLimits: {
            exceeded: boolean;
            id: string;
            limit: number;
            name: string;
            remaining: number;
            reset: number;
            window: string;
        }[];
    };
    UsageBreakdownItem: {
        dimension?: string
        | null;
        totalCostCents: number;
        totalEvents: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        totalTokens: number;
    };
    UsageBreakdownResponse: {
        data: {
            dimension?: string
            | null;
            totalCostCents: number;
            totalEvents: number;
            totalInputTokens: number;
            totalOutputTokens: number;
            totalTokens: number;
        }[];
    };
    UsageSummary: {
        totalCostCents: number;
        totalEvents: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        totalTokens: number;
    };
    UsageTimeseriesItem: {
        timestamp: string;
        totalCostCents: number;
        totalEvents: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        totalTokens: number;
    };
    UsageTimeseriesResponse: {
        data: {
            timestamp: string;
            totalCostCents: number;
            totalEvents: number;
            totalInputTokens: number;
            totalOutputTokens: number;
            totalTokens: number;
        }[];
    };
}

Type Declaration

CustomerUsageResponse: {
    customerId: string;
    totalCostCents: number;
    totalEvents: number;
    totalInputTokens: number;
    totalOutputTokens: number;
    totalTokens: number;
}
- customerId: string
  Description
  Customer identifier
- totalCostCents: number
  Description
  Total cost in cents for this customer
- totalEvents: number
  Description
  Total number of events for this customer
- totalInputTokens: number
  Description
  Total input tokens consumed
- totalOutputTokens: number
  Description
  Total output tokens generated
- totalTokens: number
  Description
  Total tokens consumed by this customer
ErrorResponse: { error: string }
Example
```
{
         *       "error": "Invalid request"
         *     }
```
- error: string
  Description
  Error message describing what went wrong
Event: {
    costCents?: number | null;
    createdAt: string;
    customerId: string;
    eventType: string;
    id: string;
    inputTokens?: number | null;
    latencyMs?: number | null;
    model?: string | null;
    outputTokens?: number | null;
    properties: { [key: string]: unknown };
    provider?: string | null;
    totalTokens?: number | null;
}
- OptionalcostCents?: number | null
  Description
  Cost in cents (if provided)
- createdAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the event was created
- customerId: string
  Description
  Customer identifier associated with the event
- eventType: string
  Description
  Type of event that was recorded
- id: string
  Description
  Unique identifier for the event
- OptionalinputTokens?: number | null
  Description
  Input tokens consumed (if provided)
- OptionallatencyMs?: number | null
  Description
  Request latency in milliseconds (if provided)
- Optionalmodel?: string | null
  Description
  Model name used (if provided)
- OptionaloutputTokens?: number | null
  Description
  Output tokens generated (if provided)
- properties: { [key: string]: unknown }
  Description
  Custom properties/dimensions associated with the event
- Optionalprovider?: string | null
  Description
  Provider name (if provided)
- OptionaltotalTokens?: number | null
  Description
  Total tokens for the event
EventsBatchPostRequest: {
    events: {
        costCents?: number;
        customerId: string;
        eventType: string;
        idempotencyKey?: string;
        inputTokens?: number;
        latencyMs?: number;
        model?: string;
        outputTokens?: number;
        properties?: { [key: string]: unknown };
        provider?: string;
        timestamp?: string;
        totalTokens?: number;
    }[];
}
- events: {
      costCents?: number;
      customerId: string;
      eventType: string;
      idempotencyKey?: string;
      inputTokens?: number;
      latencyMs?: number;
      model?: string;
      outputTokens?: number;
      properties?: { [key: string]: unknown };
      provider?: string;
      timestamp?: string;
      totalTokens?: number;
  }[]
  Description
  Array of events to ingest (max 1000)
EventsBatchPostResponse: { count: number }
- count: number
  Description
  Number of events successfully ingested
EventsPostRequest: {
    costCents?: number;
    customerId: string;
    eventType: string;
    idempotencyKey?: string;
    inputTokens?: number;
    latencyMs?: number;
    model?: string;
    outputTokens?: number;
    properties?: { [key: string]: unknown };
    provider?: string;
    timestamp?: string;
    totalTokens?: number;
}
- OptionalcostCents?: number
  Description
  Cost in cents (e.g., 25 = $0.25)
- customerId: string
  Description
  Your customer's identifier (e.g., user ID, tenant ID)
- eventType: string
  Description
  Type of event (e.g., "model_call", "embedding", "tool_call")
- OptionalidempotencyKey?: string
  Description
  Unique key for deduplication (prevents duplicate events)
- OptionalinputTokens?: number
  Description
  Number of input tokens consumed
- OptionallatencyMs?: number
  Description
  Request latency in milliseconds
- Optionalmodel?: string
  Description
  Model used (e.g., "gpt-4", "claude-3-opus", "gpt-3.5-turbo")
- OptionaloutputTokens?: number
  Description
  Number of output tokens generated
- Optionalproperties?: { [key: string]: unknown }
  Description
  Custom dimensions for filtering and grouping (e.g., user_id, team_id, feature)
- Optionalprovider?: string
  Description
  Provider name (e.g., "openai", "anthropic", "google")
- Optionaltimestamp?: string
  Format: date-time
  
  Description
  ISO 8601 timestamp (defaults to current time if not provided)
- OptionaltotalTokens?: number
  Description
  Total tokens (auto-calculated if not provided)
EventsPostResponse: { id: string }
- id: string
  Description
  Unique identifier for the ingested event
PaginationCursor: { hasMore: boolean; nextCursor: string | null }
Example
```
{
         *       "nextCursor": "eyJpZCI6ImV2dF9hYmMxMjMifQ",
         *       "hasMore": true
         *     }
```
- hasMore: boolean
  Description
  Whether there are more results available
- nextCursor: string | null
  Description
  Cursor for the next page of results. Null if there are no more results.
Project: {
    createdAt: string;
    id: string;
    name: string;
    organizationId: string;
    slug: string;
    updatedAt: string;
}
- createdAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the project was created
- id: string
  Description
  Unique identifier for the project
- name: string
  Description
  Human-readable name of the project
- organizationId: string
  Description
  ID of the organization that owns this project
- slug: string
  Description
  URL-friendly identifier for the project
- updatedAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the project was last updated
Quota: {
    createdAt: string;
    dimensionFilters: { [key: string]: unknown };
    id: string;
    limitValue: number;
    metric: string;
    name: string;
    period: string;
    projectId: string;
    updatedAt: string;
}
- createdAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the quota was created
- dimensionFilters: { [key: string]: unknown }
  Description
  Dimension filters that determine which events match this quota (e.g., {"customer_id": "cust_123", "model": "gpt-4"})
- id: string
  Description
  Unique identifier for the quota
- limitValue: number
  Description
  Quota limit value
- metric: string
  Description
  Metric being tracked (e.g., "total_tokens", "cost_cents", "total_events")
- name: string
  Description
  Human-readable name for the quota
- period: string
  Description
  Time period for the quota (e.g., "day", "month", "year")
- projectId: string
  Description
  ID of the project that owns this quota
- updatedAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the quota was last updated
QuotaAlert: {
    createdAt: string;
    id: string;
    lastTriggeredAt?: string | null;
    quotaId: string;
    threshold: number;
    updatedAt: string;
}
- createdAt: string
  Format: date-time
- id: string
- OptionallastTriggeredAt?: string | null
  Format: date-time
- quotaId: string
- threshold: number
- updatedAt: string
  Format: date-time
QuotaAlertLog: {
    currentUsage: number;
    id: string;
    limitValue: number;
    percentage: number;
    quotaAlertId: string;
    quotaId: string;
    threshold: number;
    triggeredAt: string;
    webhookResponseCode: number | null;
    webhookStatus: string;
}
- currentUsage: number
- id: string
- limitValue: number
- percentage: number
- quotaAlertId: string
- quotaId: string
- threshold: number
- triggeredAt: string
  Format: date-time
- webhookResponseCode: number | null
- webhookStatus: string
QuotaAlertsDeleteResponse: { success: boolean }
- success: boolean
  Description
  Whether the alert was successfully deleted
QuotaAlertsPostRequest: { threshold: number }
- threshold: number
  Description
  Threshold percentage (1-100) at which to trigger the alert
QuotaAlertsPutRequest: { threshold?: number }
- Optionalthreshold?: number
  Description
  Threshold percentage (1-100) at which to trigger the alert
QuotaCheckResult: {
    exceeded: boolean;
    id: string;
    limit: number;
    metric: string;
    name: string;
    period: string;
    remaining: number;
    used: number;
}
- exceeded: boolean
  Description
  Whether the quota has been exceeded
- id: string
  Description
  Unique identifier for the quota
- limit: number
  Description
  Quota limit value
- metric: string
  Description
  Metric being tracked
- name: string
  Description
  Human-readable name of the quota
- period: string
  Description
  Time period for the quota
- remaining: number
  Description
  Remaining quota (limit - used)
- used: number
  Description
  Current usage value
QuotasCheckRequest: { [key: string]: unknown }
Description
Dimensions object for quota matching (e.g., {"customer_id": "cust_123", "model": "gpt-4"})
QuotasCheckResponse: {
    allowed: boolean;
    quotas: {
        exceeded: boolean;
        id: string;
        limit: number;
        metric: string;
        name: string;
        period: string;
        remaining: number;
        used: number;
    }[];
}
- allowed: boolean
  Description
  Whether the quota check passed
- quotas: {
      exceeded: boolean;
      id: string;
      limit: number;
      metric: string;
      name: string;
      period: string;
      remaining: number;
      used: number;
  }[]
  Description
  Status of all matching quotas
QuotasDeleteResponse: { success: boolean }
- success: boolean
  Description
  Whether the quota was successfully deleted
QuotasPostRequest: {
    dimensionFilters: { [key: string]: unknown };
    limitValue: number;
    metric: "total_tokens" | "total_events" | "total_cost_cents";
    name: string;
    period: "hour" | "day" | "week" | "month";
}
- dimensionFilters: { [key: string]: unknown }
  Description
  Dimension filters that determine which events match this quota
  Default
```
{}
```
- limitValue: number
  Description
  Quota limit value
- metric: "total_tokens" | "total_events" | "total_cost_cents"
  Description
  Metric being tracked
- name: string
  Description
  Human-readable name for the quota
- period: "hour" | "day" | "week" | "month"
  Description
  Time period for the quota
QuotasPutRequest: {
    dimensionFilters?: { [key: string]: unknown };
    limitValue?: number;
    metric?: "total_tokens" | "total_events" | "total_cost_cents";
    name?: string;
    period?: "hour" | "day" | "week" | "month";
}
- OptionaldimensionFilters?: { [key: string]: unknown }
  Description
  Dimension filters that determine which events match this quota
- OptionallimitValue?: number
  Description
  Quota limit value
- Optionalmetric?: "total_tokens" | "total_events" | "total_cost_cents"
  Description
  Metric being tracked
- Optionalname?: string
  Description
  Human-readable name for the quota
- Optionalperiod?: "hour" | "day" | "week" | "month"
  Description
  Time period for the quota
QuotaStatus: {
    exceeded: boolean;
    id: string;
    limit: number;
    metric: string;
    name: string;
    period: string;
    remaining: number;
    reset: number;
    used: number;
}
- exceeded: boolean
  Description
  Whether the quota has been exceeded
- id: string
  Description
  Unique identifier for the quota
- limit: number
  Description
  Quota limit value
- metric: string
  Description
  Metric being tracked (e.g., "total_tokens", "cost_cents")
- name: string
  Description
  Human-readable name of the quota
- period: string
  Description
  Period for the quota (e.g., "day", "month", "year")
- remaining: number
  Description
  Remaining quota (limit - used)
- reset: number
  Description
  Unix timestamp when the quota period resets
- used: number
  Description
  Current usage value
RateLimit: {
    createdAt: string;
    dimensionFilters: { [key: string]: unknown };
    enabled: boolean;
    id: string;
    limitValue: number;
    name: string;
    projectId: string;
    updatedAt: string;
    window: string;
}
- createdAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the rate limit was created
- dimensionFilters: { [key: string]: unknown }
  Description
  Dimension filters that determine which requests match this rate limit (e.g., {"customer_id": "cust_123"})
- enabled: boolean
  Description
  Whether the rate limit is currently enabled
- id: string
  Description
  Unique identifier for the rate limit
- limitValue: number
  Description
  Maximum number of requests allowed in the time window
- name: string
  Description
  Human-readable name for the rate limit
- projectId: string
  Description
  ID of the project that owns this rate limit
- updatedAt: string
  Format: date-time
  
  Description
  ISO 8601 timestamp when the rate limit was last updated
- window: string
  Description
  Time window for the rate limit (e.g., "1m", "1h", "1d")
RateLimitCheckResult: {
    exceeded: boolean;
    id: string;
    limit: number;
    name: string;
    remaining: number;
    reset: number;
    window: string;
}
- exceeded: boolean
  Description
  Whether the rate limit has been exceeded
- id: string
  Description
  Unique identifier for the rate limit
- limit: number
  Description
  Maximum requests allowed in the window
- name: string
  Description
  Human-readable name of the rate limit
- remaining: number
  Description
  Number of requests remaining in the current window
- reset: number
  Description
  Unix timestamp when the rate limit window resets
- window: string
  Description
  Time window for the rate limit
RateLimitsCheckRequest: { [key: string]: unknown }
Description
Dimensions object for rate limit matching (e.g., {"customer_id": "cust_123"})
RateLimitsCheckResponse: {
    allowed: boolean;
    rateLimits: {
        exceeded: boolean;
        id: string;
        limit: number;
        name: string;
        remaining: number;
        reset: number;
        window: string;
    }[];
}
- allowed: boolean
  Description
  Whether the rate limit check passed
- rateLimits: {
      exceeded: boolean;
      id: string;
      limit: number;
      name: string;
      remaining: number;
      reset: number;
      window: string;
  }[]
  Description
  Status of all matching rate limits
RateLimitsDeleteResponse: { success: boolean }
- success: boolean
  Description
  Whether the rate limit was successfully deleted
RateLimitsPostRequest: {
    dimensionFilters: { [key: string]: unknown };
    enabled: boolean;
    limitValue: number;
    name: string;
    window: "hour" | "second" | "minute";
}
- dimensionFilters: { [key: string]: unknown }
  Description
  Dimension filters that determine which requests match this rate limit
  Default
```
{}
```
- enabled: boolean
  Description
  Whether the rate limit is enabled
  Default
```
true
```
- limitValue: number
  Description
  Maximum number of requests allowed in the time window
- name: string
  Description
  Human-readable name for the rate limit
- window: "hour" | "second" | "minute"
  Description
  Time window for the rate limit
RateLimitsPutRequest: {
    dimensionFilters?: { [key: string]: unknown };
    enabled?: boolean;
    limitValue?: number;
    name?: string;
    window?: "hour" | "second" | "minute";
}
- OptionaldimensionFilters?: { [key: string]: unknown }
  Description
  Dimension filters that determine which requests match this rate limit
- Optionalenabled?: boolean
  Description
  Whether the rate limit is enabled
- OptionallimitValue?: number
  Description
  Maximum number of requests allowed in the time window
- Optionalname?: string
  Description
  Human-readable name for the rate limit
- Optionalwindow?: "hour" | "second" | "minute"
  Description
  Time window for the rate limit
RateLimitStatus: {
    exceeded: boolean;
    id: string;
    limit: number;
    name: string;
    remaining: number;
    reset: number;
    window: string;
}
- exceeded: boolean
  Description
  Whether the rate limit has been exceeded
- id: string
  Description
  Unique identifier for the rate limit
- limit: number
  Description
  Maximum number of requests allowed in the window
- name: string
  Description
  Human-readable name of the rate limit
- remaining: number
  Description
  Number of requests remaining in the current window
- reset: number
  Description
  Unix timestamp when the rate limit window resets
- window: string
  Description
  Time window for the rate limit (e.g., "1m", "1h", "1d")
TrackPostErrorResponse: {
    allowed: boolean;
    error: string;
    quotas?: {
        exceeded: boolean;
        id: string;
        limit: number;
        metric: string;
        name: string;
        period: string;
        remaining: number;
        reset: number;
        used: number;
    }[];
    rateLimits?: {
        exceeded: boolean;
        id: string;
        limit: number;
        name: string;
        remaining: number;
        reset: number;
        window: string;
    }[];
}
- allowed: boolean
  Description
  Whether the request was allowed (always false for 429 responses)
- error: string
  Description
  Error message indicating which limit was exceeded
- Optionalquotas?: {
      exceeded: boolean;
      id: string;
      limit: number;
      metric: string;
      name: string;
      period: string;
      remaining: number;
      reset: number;
      used: number;
  }[]
  Description
  Status of all matching quotas
- OptionalrateLimits?: {
      exceeded: boolean;
      id: string;
      limit: number;
      name: string;
      remaining: number;
      reset: number;
      window: string;
  }[]
  Description
  Status of all matching rate limits
TrackPostRequest: {
    costCents?: number;
    customerId: string;
    eventType: string;
    idempotencyKey?: string;
    inputTokens?: number;
    latencyMs?: number;
    model?: string;
    outputTokens?: number;
    properties?: { [key: string]: unknown };
    provider?: string;
    timestamp?: string;
    totalTokens?: number;
}
- OptionalcostCents?: number
  Description
  Cost in cents (e.g., 25 = $0.25)
- customerId: string
  Description
  Your customer's identifier (e.g., user ID, tenant ID)
- eventType: string
  Description
  Type of event (e.g., "model_call", "embedding", "tool_call")
- OptionalidempotencyKey?: string
  Description
  Unique key for deduplication (prevents duplicate events)
- OptionalinputTokens?: number
  Description
  Number of input tokens consumed
- OptionallatencyMs?: number
  Description
  Request latency in milliseconds
- Optionalmodel?: string
  Description
  Model used (e.g., "gpt-4", "claude-3-opus", "gpt-3.5-turbo")
- OptionaloutputTokens?: number
  Description
  Number of output tokens generated
- Optionalproperties?: { [key: string]: unknown }
  Description
  Custom dimensions for quota/rate limit matching (e.g., user_id, team_id, feature)
- Optionalprovider?: string
  Description
  Provider name (e.g., "openai", "anthropic", "google")
- Optionaltimestamp?: string
  Format: date-time
  
  Description
  ISO 8601 timestamp (defaults to current time if not provided)
- OptionaltotalTokens?: number
  Description
  Total tokens (auto-calculated if not provided)
TrackPostResponse: {
    allowed: boolean;
    id: string;
    quotas: {
        exceeded: boolean;
        id: string;
        limit: number;
        metric: string;
        name: string;
        period: string;
        remaining: number;
        reset: number;
        used: number;
    }[];
    rateLimits: {
        exceeded: boolean;
        id: string;
        limit: number;
        name: string;
        remaining: number;
        reset: number;
        window: string;
    }[];
}
- allowed: boolean
  Description
  Whether the request was allowed (always true for 201 responses)
- id: string
  Description
  Unique identifier for the ingested event
- quotas: {
      exceeded: boolean;
      id: string;
      limit: number;
      metric: string;
      name: string;
      period: string;
      remaining: number;
      reset: number;
      used: number;
  }[]
  Description
  Status of all matching quotas
- rateLimits: {
      exceeded: boolean;
      id: string;
      limit: number;
      name: string;
      remaining: number;
      reset: number;
      window: string;
  }[]
  Description
  Status of all matching rate limits
UsageBreakdownItem: {
    dimension?: string | null;
    totalCostCents: number;
    totalEvents: number;
    totalInputTokens: number;
    totalOutputTokens: number;
    totalTokens: number;
}
- Optionaldimension?: string | null
  Description
  Dimension value (e.g., model name, customer ID)
- totalCostCents: number
  Description
  Total cost in cents
- totalEvents: number
  Description
  Total events for this dimension
- totalInputTokens: number
  Description
  Total input tokens
- totalOutputTokens: number
  Description
  Total output tokens
- totalTokens: number
  Description
  Total tokens for this dimension
UsageBreakdownResponse: {
    data: {
        dimension?: string | null;
        totalCostCents: number;
        totalEvents: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        totalTokens: number;
    }[];
}
- data: {
      dimension?: string | null;
      totalCostCents: number;
      totalEvents: number;
      totalInputTokens: number;
      totalOutputTokens: number;
      totalTokens: number;
  }[]
  Description
  Array of usage breakdown by dimension
UsageSummary: {
    totalCostCents: number;
    totalEvents: number;
    totalInputTokens: number;
    totalOutputTokens: number;
    totalTokens: number;
}
- totalCostCents: number
  Description
  Total cost in cents across all events
- totalEvents: number
  Description
  Total number of events in the time range
- totalInputTokens: number
  Description
  Total input tokens consumed
- totalOutputTokens: number
  Description
  Total output tokens generated
- totalTokens: number
  Description
  Total tokens consumed across all events
UsageTimeseriesItem: {
    timestamp: string;
    totalCostCents: number;
    totalEvents: number;
    totalInputTokens: number;
    totalOutputTokens: number;
    totalTokens: number;
}
- timestamp: string
  Format: date-time
  
  Description
  Timestamp for this data point
- totalCostCents: number
  Description
  Total cost in cents
- totalEvents: number
  Description
  Total events in this time bucket
- totalInputTokens: number
  Description
  Total input tokens
- totalOutputTokens: number
  Description
  Total output tokens
- totalTokens: number
  Description
  Total tokens in this time bucket
UsageTimeseriesResponse: {
    data: {
        timestamp: string;
        totalCostCents: number;
        totalEvents: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        totalTokens: number;
    }[];
}
- data: {
      timestamp: string;
      totalCostCents: number;
      totalEvents: number;
      totalInputTokens: number;
      totalOutputTokens: number;
      totalTokens: number;
  }[]
  Description
  Array of usage data over time

Interface components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

schemas

Type Declaration

CustomerUsageResponse: { customerId: string; totalCostCents: number; totalEvents: number; totalInputTokens: number; totalOutputTokens: number; totalTokens: number;}

customerId: string

Description

totalCostCents: number

Description

totalEvents: number

Description

totalInputTokens: number

Description

totalOutputTokens: number

Description

totalTokens: number

Description

ErrorResponse: { error: string }

Example

error: string

Description

OptionalcostCents?: number | null

Description

createdAt: string

Description

customerId: string

Description

eventType: string

Description

id: string

Description

OptionalinputTokens?: number | null

Description

OptionallatencyMs?: number | null

Description

Optionalmodel?: string | null

Description

OptionaloutputTokens?: number | null

Description

properties: { [key: string]: unknown }

Description

Optionalprovider?: string | null

Description

OptionaltotalTokens?: number | null

Description

events: { costCents?: number; customerId: string; eventType: string; idempotencyKey?: string; inputTokens?: number; latencyMs?: number; model?: string; outputTokens?: number; properties?: { [key: string]: unknown }; provider?: string; timestamp?: string; totalTokens?: number;}[]

Description

EventsBatchPostResponse: { count: number }

count: number

Description

EventsPostRequest: { costCents?: number; customerId: string; eventType: string; idempotencyKey?: string; inputTokens?: number; latencyMs?: number; model?: string; outputTokens?: number; properties?: { [key: string]: unknown }; provider?: string; timestamp?: string; totalTokens?: number;}

OptionalcostCents?: number

Description

customerId: string

Description

eventType: string

Description

OptionalidempotencyKey?: string

Description

OptionalinputTokens?: number

Description

OptionallatencyMs?: number

Description

Optionalmodel?: string

Description

OptionaloutputTokens?: number

Description

Optionalproperties?: { [key: string]: unknown }

Description

Optionalprovider?: string

Description

Optionaltimestamp?: string

Description

CustomerUsageResponse: {
customerId: string;
totalCostCents: number;
totalEvents: number;
totalInputTokens: number;
totalOutputTokens: number;
totalTokens: number;
}

`Optional`costCents?: number | null

`Optional`inputTokens?: number | null

`Optional`latencyMs?: number | null

`Optional`model?: string | null

`Optional`outputTokens?: number | null

`Optional`provider?: string | null

`Optional`totalTokens?: number | null

events: {
costCents?: number;
customerId: string;
eventType: string;
idempotencyKey?: string;
inputTokens?: number;
latencyMs?: number;
model?: string;
outputTokens?: number;
properties?: { [key: string]: unknown };
provider?: string;
timestamp?: string;
totalTokens?: number;
}[]

EventsPostRequest: {
costCents?: number;
customerId: string;
eventType: string;
idempotencyKey?: string;
inputTokens?: number;
latencyMs?: number;
model?: string;
outputTokens?: number;
properties?: { [key: string]: unknown };
provider?: string;
timestamp?: string;
totalTokens?: number;
}

`Optional`costCents?: number

`Optional`idempotencyKey?: string

`Optional`inputTokens?: number

`Optional`latencyMs?: number

`Optional`model?: string

`Optional`outputTokens?: number

`Optional`properties?: { [key: string]: unknown }

`Optional`provider?: string

`Optional`timestamp?: string

`Optional`totalTokens?: number

Project: {
createdAt: string;
id: string;
name: string;
organizationId: string;
slug: string;
updatedAt: string;
}

Quota: {
createdAt: string;
dimensionFilters: { [key: string]: unknown };
id: string;
limitValue: number;
metric: string;
name: string;
period: string;
projectId: string;
updatedAt: string;
}

QuotaAlert: {
createdAt: string;
id: string;
lastTriggeredAt?: string | null;
quotaId: string;
threshold: number;
updatedAt: string;
}

`Optional`lastTriggeredAt?: string | null

QuotaAlertLog: {
currentUsage: number;
id: string;
limitValue: number;
percentage: number;
quotaAlertId: string;
quotaId: string;
threshold: number;
triggeredAt: string;
webhookResponseCode: number | null;
webhookStatus: string;
}