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

# Get usage

> Returns every meter of the token team's plan as used, limit, remaining and resetsAt. A null limit is unlimited



## OpenAPI

````yaml get /usage
openapi: 3.0.4
info:
  title: Vollna API
  description: API for managing Upwork profiles, proposals, results, and filters
  version: 1.0.0
servers:
  - url: https://api.vollna.com/v1
security: []
tags:
  - name: Profiles
    description: Manage Upwork profiles
  - name: Proposals
    description: Access and manage Upwork proposals
  - name: Results
    description: View monitoring results and projects
  - name: Filters
    description: Manage monitoring filters
  - name: Auto Bidding
    description: Manage auto bidding jobs and setups
  - name: Account
    description: The token team's account, plan and meters
  - name: Invitations
    description: Upwork invitations
  - name: Projects
    description: Upwork jobs and their competition
  - name: AI Qualifier
    description: A filter's AI qualifier and its verdicts
  - name: Market Insights
    description: Upwork market analytics and saved searches
  - name: Proposal Templates
    description: Proposal templates and their results
paths:
  /usage:
    get:
      tags:
        - Account
      summary: Get usage
      description: >-
        Returns every meter of the token team's plan as used, limit, remaining
        and resetsAt. A null limit is unlimited
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      filters:
                        $ref: '#/components/schemas/Meter'
                      activeFilters:
                        $ref: '#/components/schemas/Meter'
                      qualifierCredits:
                        $ref: '#/components/schemas/Meter'
                      proposalCredits:
                        allOf:
                          - $ref: '#/components/schemas/Meter'
                        nullable: true
                        description: null when the plan has no proposal credits
                      projectCredits:
                        $ref: '#/components/schemas/Meter'
                      mcpDaily:
                        type: object
                        description: >-
                          Daily caps on heavy reads through the API and MCP. See
                          Daily caps in the introduction
                        properties:
                          explain_job:
                            $ref: '#/components/schemas/DailyMeter'
                          market_insights:
                            $ref: '#/components/schemas/DailyMeter'
                          niche_difficulty:
                            $ref: '#/components/schemas/DailyMeter'
                          keyword_opportunities:
                            $ref: '#/components/schemas/DailyMeter'
                          filter_preview:
                            $ref: '#/components/schemas/DailyMeter'
                          keyword_suggestions:
                            $ref: '#/components/schemas/DailyMeter'
                          instructions_generation:
                            $ref: '#/components/schemas/DailyMeter'
                          diagnose:
                            $ref: '#/components/schemas/DailyMeter'
                      extraCredits:
                        type: object
                        description: >-
                          Purchased credits per pool. They are spent once the
                          plan meter runs out
                        properties:
                          ai_qualifier:
                            type: number
                          ai_proposals:
                            type: number
                          api_credits:
                            type: number
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - apiToken: []
components:
  schemas:
    Meter:
      type: object
      properties:
        used:
          type: integer
        limit:
          type: integer
          nullable: true
          description: null is unlimited
        remaining:
          type: integer
          nullable: true
          description: null is unlimited
        resetsAt:
          type: string
          description: Date the meter resets, YYYY-MM-DD
          format: date
          nullable: true
    DailyMeter:
      type: object
      properties:
        used:
          type: integer
        limit:
          type: integer
          nullable: true
          description: null is unlimited, 0 is off
        remaining:
          type: integer
          nullable: true
        resetsAt:
          type: string
          description: Next reset, 00:00 UTC
          format: date-time
    ServiceError:
      type: object
      properties:
        error:
          type: string
          description: Short error title
          example: Validation failed
        message:
          type: string
          description: What went wrong and what to send instead, written for the user
        fields:
          type: object
          description: >-
            Per-field messages keyed by dot path, when several fields fail at
            once
          additionalProperties:
            type: string
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: >-
        Invalid request. message says what to send instead; fields names each
        invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    Unauthorized:
      description: Missing or unknown API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: The team's subscription is not active
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The plan has no API access, or the token team may not do this. message
        says why
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    TooManyRequests:
      description: More than 30 requests a minute. See Rate Limiting
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiToken:
      type: apiKey
      name: X-API-TOKEN
      in: header
      description: API token for authentication

````

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