> ## Documentation Index
> Fetch the complete documentation index at: https://docs.costgraph.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Summarise accelerators

> Returns how many accelerators and partitions the tenant selected by the X-CostGraph-Tenant-ID header holds, how many of those accelerators have reported, and how many ran no compute. It also carries two spend figures in currency, both estimated from the catalog rate rather than read off an invoice, so neither is billed cost: gpu_cost_month_to_date covers only the hours elapsed since the start of the current UTC month, and never charges an accelerator for hours before we first saw it; gpu_cost_projected_month is what a whole month at the current fleet and rates would come to. Both are null rather than zero where any accelerator in the fleet has no catalog rate, since a partly priced fleet has no known total.



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/gpus/summary
openapi: 3.0.0
info:
  description: Read and manage your CostGraph organization, spend, alerts, and settings.
  title: CostGraph API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.costgraph.ai
security: []
tags:
  - name: ai
    x-group: AI
  - name: ai-serving
    x-group: AI serving
  - name: anomalies
    x-group: Anomalies
  - name: auth
    x-group: Auth
  - name: billing
    x-group: Billing
  - name: billing-export
    x-group: Billing export
  - name: budgets
    x-group: Budgets
  - name: ci
    x-group: CI
  - name: compute-recommendations
    x-group: Compute recommendations
  - name: config
    x-group: Config
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: infracost
    x-group: Infracost
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network-requests
    x-group: Network requests
  - name: notifications
    x-group: Notifications
  - name: oauth
    x-group: OAuth
  - name: oauth-clients
    x-group: OAuth clients
  - name: opencost
    x-group: OpenCost
  - name: organization
    x-group: Audit log
  - name: organizations
    x-group: Organizations
  - name: placement-alternatives
    x-group: Placement alternatives
  - name: reports
    x-group: Reports
  - name: service-map
    x-group: Service map
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: user
    x-group: Users
  - name: virtual-machines
    x-group: Virtual machines
  - name: virtual-tags
    x-group: Virtual tags
  - name: workflows
    x-group: Workflows
paths:
  /api/v1/tenant/gpus/summary:
    get:
      tags:
        - gpus
      summary: Summarise accelerators
      description: >-
        Returns how many accelerators and partitions the tenant selected by the
        X-CostGraph-Tenant-ID header holds, how many of those accelerators have
        reported, and how many ran no compute. It also carries two spend figures
        in currency, both estimated from the catalog rate rather than read off
        an invoice, so neither is billed cost: gpu_cost_month_to_date covers
        only the hours elapsed since the start of the current UTC month, and
        never charges an accelerator for hours before we first saw it;
        gpu_cost_projected_month is what a whole month at the current fleet and
        rates would come to. Both are null rather than zero where any
        accelerator in the fleet has no catalog rate, since a partly priced
        fleet has no known total.
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
        - description: Summarise only one accelerator model
          name: model
          in: query
          schema:
            type: string
        - description: Summarise only one utilisation band
          name: utilization_band
          in: query
          schema:
            type: string
        - description: Summarise only the accelerators held by one instance
          name: instance_id
          in: query
          schema:
            type: string
        - description: >-
            Summarise only the accelerators on the machines of one Kubernetes
            cluster
          name: cluster_id
          in: query
          schema:
            type: string
        - description: Summarise only one or more cloud providers
          name: provider
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - description: Summarise only accelerators sitting on an instance or in a workload
          name: placement_kind
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - description: >-
            Summarise only accelerators whose model or machine name matches,
            case-insensitively
          name: search
          in: query
          schema:
            type: string
        - description: Summarise only partitioned or only whole cards
          name: partitioned
          in: query
          schema:
            type: boolean
        - description: >-
            Summarise only accelerators that reported within this window, as a
            duration such as 24h, 7d or 30d
          name: window
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/db.GPUSummaryRow'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    responses.SuccessResponse:
      type: object
      required:
        - message
        - status
      properties:
        data: {}
        message:
          type: string
          example: some message
        status:
          type: string
          example: success
    db.GPUSummaryRow:
      type: object
      properties:
        cards_flagged:
          type: integer
        currency:
          type: string
        gpu_cost_month_to_date:
          type: number
        gpu_cost_projected_month:
          type: number
        gpu_count:
          type: integer
        idle_gpu_count:
          type: integer
        idle_partition_count:
          type: integer
        instances:
          type: integer
        partitions:
          type: integer
        priced_cards:
          type: integer
        reporting_gpu_count:
          type: integer
        unpriced_cards:
          type: integer
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
  securitySchemes:
    BearerAuth:
      description: Enter "Bearer {token}"
      type: apiKey
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.