---
title: "Account, plan and credit balance"
method: GET
path: "/v1/me"
tags: ["Account"]
---

# Account, plan and credit balance

`GET /v1/me`

## Request

- Base URL: `https://api.vivideo.ai`
- URL: `https://api.vivideo.ai/v1/me`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/vivideo/apis/vivideo-api/docs/v1/me/get.ts> (a function with typed inputs; its response is checked against the schema)

Use this for credit checks and premium checks before creating videos.

## Response `200`

The account behind the API key.

- Account
  - `object` string
  - `email` string
  - `plan` 'free' | 'pro' | 'max' | 'expired'
  - `premium` boolean
  - `credits` number
  - `free_video_available` boolean: True when this free account can still create its one free preview video.
  - `first_video_comp_used` boolean
  - `links` object

## Other responses

- `401`: Missing, malformed or revoked API key (`missing_api_key`, `invalid_api_key`, `api_key_revoked`).
- `429`: Rate limit hit (`rate_limited`). Honor the `Retry-After` header / `retry_after_seconds` field.

---

[API](https://skmtc.dev/vivideo/apis/vivideo-api.md) - [All operations](https://skmtc.dev/vivideo/apis/vivideo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vivideo/apis/vivideo-api/revisions/6e8a47e72b46?raw)