OverviewPlatformsAPI Reference
Auth

Check the credential

Call this first. It shows the workspace the credential works in, its type (API key, MCP sign-in token or dashboard session), whether it can write, and for keys the id and expiry. A read key gets 403 read_only_key on any write, and scripts often aim at the wrong workspace.


GET
/v1/whoami

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/whoami"
{  "workspace": {    "id": "string",    "name": "string"  },  "auth": {    "kind": "api_key",    "scope": "read",    "apiKeyId": "string",    "expiresAt": "string"  },  "user": {    "id": "string",    "email": "string",    "name": "string"  }}
Was this page helpful?