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

# Get plan and usage

> Plan, subscription state, credit balances, plan limits and AI visibility caps. Requires `workspace:read`.



## OpenAPI

````yaml /openapi.yaml get /workspace/usage
openapi: 3.1.0
info:
  title: AeoNut API
  version: '1.0'
  description: >
    Read your workspace's AI visibility, content map and content data. Every
    response is wrapped in

    `{code, messages, data}`. Rates are fractions between 0 and 1 unless a field
    says otherwise.
servers:
  - url: https://services.deepsmith.ai/core/api/external/v1
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Me
  - name: Workspace
  - name: AI visibility
  - name: Content map
  - name: Content
  - name: IQ
paths:
  /workspace/usage:
    get:
      tags:
        - Workspace
      summary: Get plan and usage
      description: >-
        Plan, subscription state, credit balances, plan limits and AI visibility
        caps. Requires `workspace:read`.
      responses:
        '200':
          description: Plan and usage
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          plan:
                            type:
                              - object
                              - 'null'
                            properties:
                              code:
                                type: string
                                example: grow
                              name:
                                type: string
                                example: Grow
                              period:
                                type:
                                  - string
                                  - 'null'
                          subscription:
                            type: object
                            properties:
                              past_due:
                                type: boolean
                              grace:
                                type: boolean
                              active:
                                type: boolean
                              canceled:
                                type: boolean
                              trial:
                                type: boolean
                              paused:
                                type: boolean
                          renews_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                          credits:
                            type: object
                            description: >-
                              Keyed by `ARTICLE`, `AGENT_TASK`, `IDEA_RESEARCH`
                              and `INLINE_AI`.
                            additionalProperties:
                              type: object
                              properties:
                                limit:
                                  type:
                                    - integer
                                    - 'null'
                                  description: '`null` means unlimited'
                                used:
                                  type: integer
                                remaining:
                                  type:
                                    - integer
                                    - 'null'
                                resets_at:
                                  type:
                                    - string
                                    - 'null'
                                  format: date-time
                          limits:
                            type: object
                            description: Keyed by plan feature.
                            additionalProperties:
                              type: object
                              properties:
                                value:
                                  type:
                                    - integer
                                    - string
                                    - 'null'
                                  description: A number, `UNLIMITED` or `null`
                                unlimited:
                                  type: boolean
                          features:
                            type: object
                            description: Plan feature flags, keyed by feature.
                            additionalProperties: true
                          visibility:
                            type: object
                            properties:
                              prompts_tracked:
                                type: integer
                              prompts_limit: {}
                              platforms:
                                type: array
                                items:
                                  $ref: '#/components/schemas/Platform'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Envelope:
      type: object
      properties:
        code:
          type: integer
          description: AeoNut status code
        messages:
          type: string
        data: {}
    Platform:
      type: string
      enum:
        - chatgpt
        - google_ai_overview
        - perplexity
        - gemini
        - grok
        - claude
    Scope:
      type: string
      enum:
        - workspace:read
        - visibility:read
        - contentmap:read
        - content:read
        - iq:read
  responses:
    Unauthorized:
      description: Missing (`code` 4021), invalid, revoked or expired (`code` 4022) API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            code: 4022
            messages: Invalid, revoked or expired API key.
            data: null
    Forbidden:
      description: The key lacks a required scope
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Envelope'
              - properties:
                  data:
                    type: object
                    properties:
                      required:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scope'
                      missing:
                        type: array
                        items:
                          $ref: '#/components/schemas/Scope'
          example:
            code: 4023
            messages: This API key does not have the scope required for this request.
            data:
              required:
                - visibility:read
              missing:
                - visibility:read
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer API Key Value`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

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