Account

Check your key

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.

get/me

Request

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

Response

Your key and workspace.

Example response

{
  "key": {
    "id": "key_cmf3jz0aa0000ab12cd34ef56",
    "name": "Zapier",
    "scopes": [
      "read",
      "write"
    ]
  },
  "workspace": {
    "id": "ws_cmf3jy9bb0000ab12cd34ef56",
    "name": "Northside Studio"
  },
  "plan": {
    "name": "Standard"
  },
  "usage": {
    "period": "2026-09",
    "resets_at": "2026-10-01T15:00:00.000Z",
    "videos": {
      "used": 12
    }
  },
  "limits": {
    "requests_per_minute": {
      "read": 60,
      "write": 20
    },
    "api_posts_per_day": {
      "limit": 30,
      "used": 4,
      "scope": "organization",
      "resets_at": "2026-10-01T15:00:00.000Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.