---
title: "Check your key"
method: GET
path: "/me"
tags: ["Account"]
---

# Check your key

`GET /me`

## Request

- Base URL: `https://api.deploy.social/v1`
- URL: `https://api.deploy.social/v1/me`
- Auth: HTTP bearer

The key you're using, its workspace, your plan, how many videos you've posted this month, and what your plan allows through the API: requests a minute, and API posts today. A good first call to check a key works.

## Response `200`

Your key and workspace.

- Me
  - `key` object, required
    - `id` string, required: The API key's id. Starts with `key_`.
    - `name` string, required: The name you gave the key.
    - `scopes` string[], required: What the key can do. `write` includes `read`.
  - `workspace` object, required
    - `id` string, required: The workspace's id. Starts with `ws_`.
    - `name` string, required
  - `plan` object, required
    - `name` string, required
  - `usage` object, required
    - `period` string, required: The month the allowance counts, as YYYY-MM (UTC).
    - `resets_at` string, date-time, required: When the allowance starts over.
    - `videos` object, required
      - `used` integer, required: Posts this month, of any kind.
      - `limit` integer, nullable, required: Posts you can make each month, of any kind. `null` means no monthly limit.
  - `limits` object, required: What your plan allows through the API.
    - `requests_per_minute` object, required: Per-key limits. REST and MCP calls share them.
      - `read` integer, required: GET requests this key can make each minute.
      - `write` integer, required: Other requests this key can make each minute.
    - `api_posts_per_day` object, required: Drafts, reschedules, cancels and retries don't count, and neither does anything posted in the app.
      - `limit` integer, required: Posts the API and MCP can publish or schedule each UTC day.
      - `used` integer, required: Posts the API and MCP have published or scheduled today.
      - `scope` 'organization' | 'workspace', required: What the allowance is shared across: every workspace in your account (Standard) or this workspace alone (Studio).
      - `resets_at` string, date-time, required: The next midnight UTC, when `used` starts over.

## Other responses

- `401`: The API key is missing, wrong, revoked or expired: `missing_api_key`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`.
- `403`: The key can't do this: `insufficient_scope` (a read-only key), `plan_required`, `usage_limit_exceeded` (this month's videos are used up), `access_revoked` (its creator left the workspace), `workspace_archived`.
- `429`: Slow down and wait `Retry-After` seconds. Either this key has used its requests for the minute (Standard: 60 reads and 20 writes, Studio: 120 and 30), or, when publishing or scheduling, the plan's API posts for the day are used (detail code `daily_post_limit`; Standard: 30 a day across your account, Studio: 100 a day per workspace; `Retry-After` runs to midnight UTC). Posts made in the app never count.
- `500`: Something broke on our side. Retry, and contact us with the request id if it keeps happening.
- `503`: We can't take the request right now. Retry shortly.

---

[API](https://skmtc.dev/deploy/apis/deploy-social-api.md) · [All operations](https://skmtc.dev/deploy/apis/deploy-social-api/llms.txt) · [OpenAPI document](https://skmtc.dev/deploy/apis/deploy-social-api/revisions/7ed97bdd207f?raw)