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

# Get Credits Usage

> Query the current user and token credit balance and usage information



## OpenAPI

````yaml /en/api-manual/account-management/get-credits.json GET /v1/credits
openapi: 3.1.0
info:
  title: Get Credits Usage API
  description: Query the current user and token credit balance and usage information
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.evolink.ai
    description: Production Environment
security:
  - bearerAuth: []
tags:
  - name: Account Management
    description: Account-related APIs, including credit queries and more
paths:
  /v1/credits:
    get:
      tags:
        - Account Management
      summary: Get Credits Usage
      description: Query the current user and token credit balance and usage information
      operationId: getCredits
      responses:
        '200':
          description: Credits information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsResponse'
              example:
                data:
                  token:
                    remaining_credits: 99416.4429
                    unlimited_credits: false
                    used_credits: 583.5571
                  user:
                    remaining_credits: 1095.3996
                    used_credits: 135.9048
                message: ''
                success: true
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: Invalid request
                  type: invalid_request_error
        '401':
          description: Authentication failed, invalid or expired token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 401
                  message: Invalid or expired token
                  type: authentication_error
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 403
                  message: Access denied
                  type: permission_error
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 429
                  message: Rate limit exceeded
                  type: rate_limit_error
                  fallback_suggestion: retry after 60 seconds
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: Internal server error
                  type: internal_server_error
                  fallback_suggestion: try again later
        '502':
          description: Upstream service error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 502
                  message: Upstream service error
                  type: upstream_error
                  fallback_suggestion: try again later
        '503':
          description: Service temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 503
                  message: Service temporarily unavailable
                  type: service_unavailable_error
                  fallback_suggestion: retry after 30 seconds
components:
  schemas:
    CreditsResponse:
      type: object
      required:
        - data
        - message
        - success
      properties:
        data:
          type: object
          required:
            - token
            - user
          properties:
            token:
              type: object
              description: Token credit information
              required:
                - remaining_credits
                - unlimited_credits
                - used_credits
              properties:
                remaining_credits:
                  type: number
                  format: double
                  description: Remaining credits for the token
                  example: 99416.4429
                unlimited_credits:
                  type: boolean
                  description: Whether the token has unlimited credits
                  example: false
                used_credits:
                  type: number
                  format: double
                  description: Credits used by the token
                  example: 583.5571
            user:
              type: object
              description: User credit information
              required:
                - remaining_credits
                - used_credits
              properties:
                remaining_credits:
                  type: number
                  format: double
                  description: Remaining credits for the user
                  example: 1095.3996
                used_credits:
                  type: number
                  format: double
                  description: Credits used by the user
                  example: 135.9048
        message:
          type: string
          description: Response message
          example: ''
        success:
          type: boolean
          description: Whether the request was successful
          example: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              description: HTTP status error code
              example: 401
            message:
              type: string
              description: Error description
              example: Invalid or expired token
            type:
              type: string
              description: Error type
              example: authentication_error
            param:
              type: string
              description: Related parameter name
              example: token
            fallback_suggestion:
              type: string
              description: Error handling suggestion
              example: retry after 60 seconds
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        ##All APIs require Bearer Token authentication##


        **Get API Key:**


        Visit [API Key Management Page](https://evolink.ai/dashboard/keys) to
        get your API Key


        **Add to request header:**

        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````