> For the complete documentation index, see [llms.txt](https://bountyv.gitbook.io/vdocs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bountyv.gitbook.io/vdocs/account/me.md).

# Account info

Lightweight account snapshot: current balance, product entitlements, and live per-action pricing for your tier. Native/desktop clients poll this so that access changes made in the admin panel (e.g. enabling a product) take effect without a re-login.

```
GET /api/v1/me
```

Synchronous.

## Authentication

Requires a Bearer API key. See [Authentication](/vdocs/authentication.md).

## Request

No body. Just the `Authorization` header.

| Field | Type | Required | Description                       |
| ----- | ---- | -------- | --------------------------------- |
| —     | —    | —        | This endpoint takes no parameters |

## Response

```json
{
  "username": "acme-corp",
  "currency": "V-Tokens",
  "unlimited": false,
  "balance_tokens": 5000,
  "pricing_tokens": { "text_to_image": 32, "image_to_video": 99, "thumbnail": 20 },
  "balance_cents": 5000,
  "products": {
    "image": true,
    "nsfw": false,
    "video": true,
    "soul": true,
    "clip": true,
    "youtube": true,
    "gamedev": true
  },
  "pricing": {
    "text_to_image": 18,
    "image_edit": 20,
    "image_to_image": 20,
    "image_to_video": 70,
    "identity_create": 500,
    "identity_image": 20,
    "thumbnail": 15,
    "wan_reel": 90,
    "lyric_video": 60,
    "music_short": 40,
    "clean_clip": 25,
    "clip_split": 25,
    "clip_stitch": 25
  }
}
```

| Field           | Type    | Description                                                                                                                                                                                                                                                             |
| --------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `username`      | string  | Your account's username                                                                                                                                                                                                                                                 |
| `balance_cents` | integer | Available balance, in US cents (100 = $1.00)                                                                                                                                                                                                                            |
| `products`      | object  | Booleans for which product surfaces are enabled on your account: `image`, `nsfw`, `video`, `soul`, `clip`, `youtube`, `gamedev`                                                                                                                                         |
| `pricing`       | object  | Per-action `charge_cents` for your account's cost tier — keys: `text_to_image`, `image_edit`, `image_to_image`, `image_to_video`, `identity_create`, `identity_image`, `thumbnail`, `wan_reel`, `lyric_video`, `music_short`, `clean_clip`, `clip_split`, `clip_stitch` |

Values in the example above are illustrative — read pricing from this response (or from [`GET /api/v1/credits`](/vdocs/account/credits.md)) at runtime rather than hardcoding it.

If a `products` flag is `false`, calls to the corresponding endpoints will be rejected even if you have sufficient balance — contact support to enable a product on your account.

## Example

```bash
curl https://substance-api.com/api/v1/me \
  -H "Authorization: Bearer sk_live_..."
```

## Errors

| Status | When                                   |
| ------ | -------------------------------------- |
| `401`  | Missing, malformed, or revoked API key |
| `403`  | Account disabled — contact support     |
| `429`  | Rate limit exceeded for your key       |

See [Errors](/vdocs/errors.md) for the full error format.

## Pricing

This endpoint is free to call. For the charges applied to the actions it reports pricing for, see [Credits & pricing](/vdocs/account/credits.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bountyv.gitbook.io/vdocs/account/me.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.