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

# Get account & credits

> Returns the user and key behind the credentials on this request, plus the live credit balance. Useful as a health check while wiring up an integration, or to show remaining credits inside your own dashboard.




## OpenAPI

````yaml GET /api/v2/me
openapi: 3.1.0
info:
  title: Kodisc API
  version: 2.0.0
  description: >
    The Kodisc public API turns [Manim](https://www.manim.community) Python code
    into rendered MP4 videos, thumbnails, and captions.


    Renders run asynchronously: you `POST /api/v2/render` to enqueue a job, get
    back a `jobId`, then either poll `GET /api/v2/render/{jobId}` or receive a
    webhook callback when the job reaches a terminal state.


    All endpoints accept and return JSON. Authenticate every request with an API
    key — see [Authentication](/authentication).
  contact:
    name: Kodisc
    url: https://kodisc.com
servers:
  - url: https://kodisc.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Render
    description: Enqueue Manim render jobs and poll their status.
  - name: Account
    description: Inspect the authenticated key and your credit balance.
paths:
  /api/v2/me:
    get:
      tags:
        - Account
      summary: Get account & credit balance
      description: >
        Returns the user and key behind the credentials on this request, plus
        the live credit balance. Useful as a health check while wiring up an
        integration, or to show remaining credits inside your own dashboard.
      operationId: getMe
      responses:
        '200':
          description: Account info and credits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
              example:
                userId: usr_xxxxxxxxxxxxxxxxxxx
                keyId: key_xxxxxxxxxxxxxxxx
                keyPrefix: kdsc_live_xxxx
                credits:
                  paid: 1840
                  free: 200
                  total: 2040
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    MeResponse:
      type: object
      required:
        - userId
        - keyId
        - keyPrefix
        - credits
      properties:
        userId:
          type: string
        keyId:
          type: string
          description: Internal ID for the key being used to authenticate this request.
        keyPrefix:
          type: string
          description: >-
            First 16 characters of the API key (e.g. `kdsc_live_xxxx`). Safe to
            display in your UI to help users identify which key is in use.
        credits:
          $ref: '#/components/schemas/Credits'
    Credits:
      type: object
      required:
        - paid
        - free
        - total
      properties:
        paid:
          type: number
          description: Credits remaining from purchased credit packs.
        free:
          type: number
          description: Credits remaining from your plan's monthly free allotment.
        total:
          type: number
          description: Sum of `paid + free`.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Short machine-friendly error code or summary.
        message:
          type: string
          description: Optional human-readable explanation.
  responses:
    Unauthorized:
      description: The API key is missing, malformed, revoked, or unknown.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Unauthorized
            message: Invalid or missing API key
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: kdsc_live_*
      description: >
        Send your API key in the `Authorization` header as `Bearer
        kdsc_live_<...>`. Generate keys from the [developer
        dashboard](https://kodisc.com/developer/keys). Keys are returned in
        plaintext only once at creation time — store them like a password.

````