---
title: "Read the caller workspace entitlement"
method: GET
path: "/api/v1/credits"
tags: ["credits"]
---

# Read the caller workspace entitlement

`GET /api/v1/credits`

## Request

- Base URL: `https://mdtidy.com`
- URL: `https://mdtidy.com/api/v1/credits`
- Auth: HTTP bearer

Returns the entitlement object the workspace UI gates on (`can_save` / `can_share` / `unlimited_save`). Derived server-side from the wallet balance + plan. Unauthenticated callers receive a 200 with every gate closed.

## Response `200`

Entitlement object.

- Entitlement
  - `signed_in` boolean, required
  - `credits_balance` integer, required
  - `plan` 'free' | 'premium', required
  - `can_save` boolean, required
  - `can_share` boolean, required
  - `unlimited_save` boolean, required

## Other responses

- `500`: Server failed to complete the request.

---

[API](https://skmtc.dev/mdtidy/apis/markdown-tidy-api.md) · [All operations](https://skmtc.dev/mdtidy/apis/markdown-tidy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mdtidy/apis/markdown-tidy-api/revisions/caeec6fad155?raw)