> ## Documentation Index > Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get account model usage > Read recorded model calls and tokens for an account. Requires account.billing.read. ## OpenAPI ````yaml /cloud/rest/openapi.json get /accounts/{account_id}/usage/models openapi: 3.1.0 info: title: Veryfront REST API reference version: 1.0.0 description: >- ## Explore the API | Domain | Use it to | | --- | --- | | [Projects](#tag/projects) | Manage projects and files. | | [Agents](#tag/agents) | Manage agent primitives. | | [Orchestration](#tag/execution) | Manage conversations and runs. | | [Evaluations](#tag/evaluations) | Manage evaluations and results. | | [AI Gateway](#tag/ai-gateway) | Discover models, control access, run inference and measure model usage. | | [MCP](#tag/mcp) | Discover tools and authorization. | | [Integrations](#tag/integrations) | Manage connections and integrations. | | [Knowledge](#tag/knowledge) | Manage documents and search. | | [Deployments](#tag/deployments) | Manage releases and deployments. | | [Runtime](#tag/runtime) | Manage environments and infrastructure. | | [Observability](#tag/observability) | Monitor activity and performance. | | [Identity & Access](#tag/identity-access) | Manage identity and access. | | [Billing & Usage](#tag/billing-usage) | Manage billing and usage. | | [Other](#tag/platform) | Inspect health and API metadata. | [OpenAPI specification (JSON)](/openapi.json) contact: name: Veryfront API Support url: https://veryfront.com/docs email: support@veryfront.com x-api-id: 5f1f0b8a-6b0e-4c1a-9b35-0f3a1e6d84c7 x-audience: external-public servers: - url: https://api.veryfront.com security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: projects description: Manage projects and files. - name: agents description: Manage agent primitives. - name: execution description: Manage conversations and runs. - name: evaluations description: Manage evaluations and results. - name: ai-gateway description: Discover models, control access, run inference and measure model usage. - name: mcp description: Discover tools and authorization. - name: integrations description: Manage connections and integrations. - name: knowledge description: Manage documents and search. - name: deployments description: Manage releases and deployments. - name: runtime description: Manage environments and infrastructure. - name: observability description: Monitor activity and performance. - name: identity-access description: Manage identity and access. - name: billing-usage description: Manage billing and usage. - name: platform description: Inspect health and API metadata. - name: projects/Projects - name: projects/Projects/Favorites - name: projects/Projects/Account Projects - name: projects/Projects/Projects - name: projects/Projects/Project Labels - name: projects/Projects/Project templates - name: projects/Files - name: projects/Files/Files - name: projects/Files/File Chunks - name: projects/Files/Branch File Versions - name: projects/Files/Branch Files - name: projects/Files/Environment Files - name: projects/Files/File Versions - name: projects/Files/Branch File Drafts - name: projects/Files/Release Files - name: projects/Files/Sandbox Files - name: projects/Files/File Search - name: projects/Branches - name: projects/Branches/Branches - name: projects/Branches/Branch Policies - name: projects/Branches/Branch Approvals - name: projects/Branches/Branch Status Checks - name: projects/Branches/Project Commits - name: projects/Branches/Branch Merges - name: projects/Uploads - name: projects/Uploads/Upload Folders - name: projects/Uploads/Upload Grants - name: projects/Uploads/Project Uploads - name: projects/Uploads/Upload Visibility - name: agents/Agents - name: agents/Agents/Agents - name: agents/Agents/Agent Labels - name: agents/Agents/Agent templates - name: agents/Agents/Agent Tool References - name: agents/Agents/Agent Avatars - name: agents/Agents/Agent Capabilities - name: agents/Agents/Agent Installation - name: agents/Prompts - name: agents/Prompts/Project prompts - name: agents/Tools - name: agents/Tools/Project tools - name: agents/Skills - name: agents/Skills/Project skills - name: agents/Resources - name: agents/Resources/Project resources - name: agents/Tasks - name: agents/Tasks/Tasks - name: agents/Workflows - name: agents/Workflows/Workflows - name: execution/Conversations - name: execution/Conversations/Conversations - name: execution/Conversations/Conversation messages - name: execution/Conversations/Conversation participants - name: execution/Conversations/Conversation read state - name: execution/Triggers - name: execution/Triggers/Project schedules - name: execution/Triggers/Webhooks - name: execution/Triggers/Webhook events - name: execution/Runs - name: execution/Runs/Run Input Requests - name: execution/Runs/Runs - name: execution/Runs/Runtime - name: execution/Runs/Child Runs - name: execution/Runs/Conversation Runs - name: execution/Runs/Project Runs - name: execution/Runs/Webhook Runs - name: execution/Runs/Run Events - name: execution/Runs/Run Actions - name: execution/Runs/Run Artifacts - name: execution/Executors - name: execution/Executors/Connected agents - name: execution/Executors/Agent workers - name: evaluations/Evaluations - name: evaluations/Evaluations/Evaluations - name: evaluations/Evaluations/Evaluation Runs - name: ai-gateway/Models - name: ai-gateway/Models/Model discovery - name: ai-gateway/Models/Inference Models - name: ai-gateway/Models/Project inference policy - name: ai-gateway/Models/Account inference policy - name: ai-gateway/Provider credentials - name: ai-gateway/Provider credentials/Account provider credentials - name: ai-gateway/Inference - name: ai-gateway/Inference/OpenAI Chat Completions - name: ai-gateway/Inference/Embeddings - name: ai-gateway/Inference/OpenAI Responses - name: ai-gateway/Inference/Proxy metadata - name: ai-gateway/Inference/Anthropic Messages - name: ai-gateway/Inference/Provider gateway - name: ai-gateway/Inference/Gemini inference - name: ai-gateway/Inference/Image generation - name: ai-gateway/Model usage - name: ai-gateway/Model usage/Model usage - name: mcp/Tools - name: mcp/Tools/MCP discovery - name: mcp/Authorization - name: mcp/Authorization/Protected resource discovery - name: integrations/Integrations - name: integrations/Integrations/Integration tools - name: integrations/Integrations/Integration catalog - name: integrations/Integrations/Project integrations - name: integrations/Connections - name: integrations/Connections/Connections - name: integrations/Channels - name: integrations/Channels/Channels - name: integrations/Channels/Setup lookups - name: integrations/External storage - name: integrations/External storage/External Files - name: knowledge/Documents - name: knowledge/Documents/Project knowledge - name: knowledge/Documents/Retrieval documents - name: knowledge/Documents/Knowledge assets - name: knowledge/Search - name: knowledge/Search/Search - name: knowledge/Embeddings - name: knowledge/Embeddings/Project embeddings - name: deployments/Releases - name: deployments/Releases/Releases - name: deployments/Releases/Release Source Manifests - name: deployments/Deployments - name: deployments/Deployments/Project deployments - name: deployments/Artifacts - name: deployments/Artifacts/Dependencies - name: deployments/Artifacts/Release Asset Manifests - name: deployments/Artifacts/Style artifacts - name: runtime/Environments - name: runtime/Environments/Environments - name: runtime/Environments/Environment Domains - name: runtime/Environments/Environment variables - name: runtime/Servers - name: runtime/Servers/Servers - name: runtime/Servers/Server Environments - name: runtime/Sandboxes - name: runtime/Sandboxes/Sandbox Lifecycle - name: runtime/Sandboxes/Sandbox Commands - name: runtime/Sandboxes/Sandbox Environment - name: runtime/Sandboxes/Sandbox Health - name: runtime/Sandboxes/Sandbox Terminal - name: runtime/Cache - name: runtime/Cache/Project Cache - name: observability/Logs - name: observability/Logs/Log entries - name: observability/Traces - name: observability/Traces/Trace spans - name: observability/Traces/Project traces - name: observability/Traces/Trace Search - name: observability/Metrics - name: observability/Metrics/Metric series - name: observability/Alerts - name: observability/Alerts/Project alerts - name: observability/Error types - name: observability/Error types/Error types - name: identity-access/Users - name: identity-access/Users/Account users - name: identity-access/Users/Project members - name: identity-access/Users/Current user - name: identity-access/Accounts - name: identity-access/Accounts/Accounts - name: identity-access/Invitations - name: identity-access/Invitations/Invitations - name: identity-access/API keys - name: identity-access/API keys/API keys - name: identity-access/Authentication - name: identity-access/Authentication/Sign-in - name: identity-access/Authentication/Tokens - name: identity-access/Authorization - name: identity-access/Authorization/Authorized apps - name: identity-access/Authorization/General OAuth - name: identity-access/Authorization/Consent - name: billing-usage/Subscriptions - name: billing-usage/Subscriptions/Subscription - name: billing-usage/Subscriptions/Seats - name: billing-usage/Billing - name: billing-usage/Billing/Billing details - name: billing-usage/Billing/Invoices and payments - name: billing-usage/Credits - name: billing-usage/Credits/Credits - name: billing-usage/Feature gates - name: billing-usage/Feature gates/Feature gates - name: billing-usage/Budgets - name: billing-usage/Budgets/Budgets - name: billing-usage/Usage - name: billing-usage/Usage/API key usage - name: billing-usage/Usage/Usage - name: billing-usage/Usage/Project usage - name: billing-usage/Analytics - name: billing-usage/Analytics/Conversation Analytics - name: billing-usage/Analytics/Run Analytics - name: platform/Other - name: platform/Other/API metadata paths: /accounts/{account_id}/usage/models: get: tags: - ai-gateway/Model usage/Model usage summary: Get account model usage description: >- Read recorded model calls and tokens for an account. Requires account.billing.read. operationId: getAccountModelUsage parameters: - schema: type: string format: uuid required: true name: account_id in: path - $ref: '#/components/parameters/UsageQueryPreset' - $ref: '#/components/parameters/UsageQueryFrom' - $ref: '#/components/parameters/UsageQueryTo' - $ref: '#/components/parameters/UsageQueryTimezone' - $ref: '#/components/parameters/UsageQueryGranularity' - $ref: '#/components/parameters/UsageQueryGroupBy' - $ref: '#/components/parameters/UsageQueryCompare' - schema: type: string format: uuid description: Filter to calls with this recorded actor user ID. required: false description: Filter to calls with this recorded actor user ID. name: member_id in: query - schema: type: string minLength: 1 maxLength: 255 description: Project UUID or slug within the selected account. required: false description: Project UUID or slug within the selected account. name: project_reference in: query responses: '200': description: Recorded account model usage. content: application/json: schema: $ref: '#/components/schemas/ModelUsageReport' '400': description: Bad request content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '409': description: Conflict content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: Server error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' components: parameters: UsageQueryPreset: schema: $ref: '#/components/schemas/UsageQueryPreset' required: false description: >- Whole local days, defaulting to 30d. Explicit from/to bounds take precedence over preset, including SDK-supplied defaults. name: preset in: query UsageQueryFrom: schema: $ref: '#/components/schemas/UsageQueryFrom' required: false description: >- Inclusive start. Supply both from and to; these bounds take precedence over preset. name: from in: query UsageQueryTo: schema: $ref: '#/components/schemas/UsageQueryTo' required: false description: Exclusive end, no later than the end of today in timezone. name: to in: query UsageQueryTimezone: schema: $ref: '#/components/schemas/UsageQueryTimezone' required: false name: timezone in: query UsageQueryGranularity: schema: $ref: '#/components/schemas/UsageQueryGranularity' required: false description: UTC hours, or local calendar days, Monday-based weeks and months. name: granularity in: query UsageQueryGroupBy: schema: $ref: '#/components/schemas/UsageQueryGroupBy' required: false description: >- Grouping dimensions supported by this operation. Repeat the parameter or use a comma-separated list. name: group_by in: query style: form explode: true UsageQueryCompare: schema: $ref: '#/components/schemas/UsageQueryCompare' required: false description: >- Compare preceding calendar months for whole-month custom ranges, local days for whole-day ranges and presets, or equal elapsed duration otherwise. name: compare in: query schemas: ModelUsageReport: type: object properties: scope: oneOf: - type: object properties: kind: type: string enum: - account account_id: type: string format: uuid project_id: type: - string - 'null' format: uuid member_id: type: - string - 'null' format: uuid required: - kind - account_id - project_id - member_id - type: object properties: kind: type: string enum: - project project_id: type: string format: uuid member_id: type: - string - 'null' format: uuid required: - kind - project_id - member_id timeframe: type: object properties: from: type: string format: date-time description: Inclusive start. to: type: string format: date-time description: Exclusive end. timezone: type: string granularity: type: string enum: - hour - day - week - month bucket_count: type: integer minimum: 0 previous: type: object properties: from: type: string format: date-time description: Inclusive start. to: type: string format: date-time description: Exclusive end. timezone: type: string granularity: type: string enum: - hour - day - week - month bucket_count: type: integer minimum: 0 required: - from - to - timezone - granularity - bucket_count required: - from - to - timezone - granularity - bucket_count summary: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 models_used: type: integer minimum: 0 description: Distinct vendor and model IDs, across inference providers. previous: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 models_used: type: integer minimum: 0 description: Distinct vendor and model IDs, across inference providers. required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - models_used required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - models_used group_by: type: array items: type: string enum: - project - model - api_key - member description: >- Requested series grouping dimensions; omitted for the default report. models: type: array items: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 serving: type: array items: type: object properties: host: type: - string - 'null' region: type: - string - 'null' required: - host - region additionalProperties: false description: >- Recorded serving hosts and regions. A null entry preserves calls whose serving location was not recorded; omitted when none was recorded. model: type: string description: >- Canonical catalog model ID where recorded; otherwise the normalized historical ID. model_provider: type: string description: Model vendor ID. Unknown vendors remain valid strings. inference_provider: type: string description: Recorded inference provider, or unknown when unavailable. required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - model - model_provider - inference_provider description: >- One row per model/vendor/inference-provider identity, ranked by calls. projects: type: array items: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 project_id: type: - string - 'null' format: uuid project_name: type: - string - 'null' project_slug: type: - string - 'null' models: type: array items: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 serving: type: array items: type: object properties: host: type: - string - 'null' region: type: - string - 'null' required: - host - region additionalProperties: false description: >- Recorded serving hosts and regions. A null entry preserves calls whose serving location was not recorded; omitted when none was recorded. model: type: string description: >- Canonical catalog model ID where recorded; otherwise the normalized historical ID. model_provider: type: string description: Model vendor ID. Unknown vendors remain valid strings. inference_provider: type: string description: >- Recorded inference provider, or unknown when unavailable. required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - model - model_provider - inference_provider required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - project_id - project_name - project_slug - models description: >- Account usage by project and model; null project ID is unscoped usage. Empty for project reports. series: type: array items: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 bucket_start: type: string format: date-time models: type: array items: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 serving: type: array items: type: object properties: host: type: - string - 'null' region: type: - string - 'null' required: - host - region additionalProperties: false description: >- Recorded serving hosts and regions. A null entry preserves calls whose serving location was not recorded; omitted when none was recorded. model: type: string description: >- Canonical catalog model ID where recorded; otherwise the normalized historical ID. model_provider: type: string description: Model vendor ID. Unknown vendors remain valid strings. inference_provider: type: string description: >- Recorded inference provider, or unknown when unavailable. required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - model - model_provider - inference_provider groups: type: array items: type: object properties: funding: type: string enum: - managed - customer - mixed description: >- Recorded model funding; omitted when any included call has unknown funding. capture: type: object properties: complete_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly complete provider token capture, including measured zero. partial_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with explicitly partial provider token capture. missing_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls explicitly recorded without provider token usage. unknown_requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Calls with absent or unrecognized capture status; never assumed complete. required: - complete_requests - partial_requests - missing_requests - unknown_requests description: >- Token capture completeness. These counts sum to requests. Token totals include recorded counters only; unknown or missing tokens are not measured zero. Capture status does not establish settlement or estimation status. requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Recorded model calls, not platform HTTP requests. input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized uncached input tokens; cache dimensions are reported separately. output_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Normalized output tokens, including separately reported reasoning where the provider convention requires it. cache_creation_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cache_read_input_tokens: type: integer minimum: -9007199254740991 maximum: 9007199254740991 dimensions: type: object properties: project_id: type: - string - 'null' format: uuid model: type: - string - 'null' model_provider: type: - string - 'null' api_key_id: type: - string - 'null' format: uuid api_key_kind: type: string enum: - api_key - no_api_key - other_keys - deleted_keys - unattributed description: >- Key-listing reports distinguish named keys, other/deleted keys, keyless and unattributed usage. member_id: type: - string - 'null' format: uuid member_kind: type: string enum: - member - former_member - deleted_users - automations - unattributed description: >- Project-member reports distinguish named people, deleted users, automations and unattributed usage. required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - dimensions required: - capture - requests - input_tokens - output_tokens - cache_creation_input_tokens - cache_read_input_tokens - bucket_start - models description: >- Bucket totals and model breakdowns. Quiet buckets have zero totals and no model or grouping rows. attribution: type: object properties: enabled: type: boolean description: Whether actor attribution is being recorded now. member_filtered: type: boolean description: >- Member-filtered reports contain only calls with that recorded actor. Older unrecorded calls and automation are excluded. required: - enabled - member_filtered required: - scope - timeframe - summary - models - projects - series - attribution Problem: type: object properties: cause: type: string enum: - schedule_concurrency_forbidden - schedule_fire_in_progress - schedule_run_limit_reached description: Schedule admission refusal. idempotency: type: object properties: state: type: string enum: - in_progress - payload_mismatch - outcome_unknown operation: type: string minLength: 1 retryable: type: boolean retry_after_seconds: type: - integer - 'null' minimum: 0 expires_at: type: - string - 'null' recovery: type: object properties: available: type: boolean description: type: string resource_url: type: string required: - available - description required: - state - operation - retryable - retry_after_seconds - expires_at description: Replay status, retry timing, and recovery lookup. type: type: string description: URI reference identifying the problem type example: https://api.veryfront.com/errors/validation-failed title: type: string description: Short human-readable summary of the problem example: Validation Failed status: type: integer minimum: 100 maximum: 599 description: HTTP status code example: 400 code: type: string description: Stable machine-readable error code example: RUN_INVALID_INPUT detail: type: string description: Human-readable explanation specific to this occurrence example: The 'email' field must be a valid email address instance: type: string description: URI reference identifying the specific occurrence example: /projects/my-project/members slug: type: string description: Stable identifier for the problem type example: validation-failed category: type: string enum: - AUTH - RESOURCE - VALIDATION - DATABASE - SUBSCRIPTION - INTEGRATION - INTERNAL description: API error category example: VALIDATION suggestion: type: string description: Suggested action to resolve the problem example: >- Check the request body and query parameters against the API documentation. errors: type: array items: type: object properties: field: type: string description: Field path that caused the error example: email message: type: string description: Error message for this field example: Invalid email format code: type: string description: Error code for this field example: INVALID_FORMAT required: - field - message description: Detailed field-level errors for validation failures required: - type - title - status UsageQueryPreset: type: string enum: - 7d - 30d - 90d default: 30d description: >- Whole local days, defaulting to 30d. Explicit from/to bounds take precedence over preset, including SDK-supplied defaults. UsageQueryFrom: type: string format: date-time description: >- Inclusive start. Supply both from and to; these bounds take precedence over preset. UsageQueryTo: type: string format: date-time description: Exclusive end, no later than the end of today in timezone. UsageQueryTimezone: type: string default: UTC UsageQueryGranularity: type: string enum: - hour - day - week - month default: day description: UTC hours, or local calendar days, Monday-based weeks and months. UsageQueryGroupBy: type: array items: type: string enum: - project - model - api_key - member maxItems: 4 description: >- Grouping dimensions supported by this operation. Repeat the parameter or use a comma-separated list. UsageQueryCompare: type: string enum: - previous_period description: >- Compare preceding calendar months for whole-month custom ranges, local days for whole-day ranges and presets, or equal elapsed duration otherwise. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or API Key description: >- Use a JWT bearer token or a Veryfront API key in the `Authorization` header. apiKeyAuth: type: apiKey in: header name: X-API-Key description: Alternative API key header for `vf__` tokens. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.