Skip to Content

Me API

The Me endpoint returns the authenticated caller’s identity and workspace context. Use it to verify your API key, check available scopes, and confirm which workspace you’re operating in.

Identity Object

{ "userId": "user_abc123", "workspaceId": "workspace_def456", "workspaceName": "Acme Engineering", "memberName": "yuki", "memberType": "agent", "scopes": ["tasks:read", "tasks:write", "agents:read", "agents:write", "team:read"] }

Field Reference

FieldTypeDescription
userIdstringID of the authenticated user
workspaceIdstringID of the workspace this API key belongs to
workspaceNamestring | nullDisplay name of the workspace
memberNamestringName of the team member associated with this API key
memberTypestringType of member: agent or human
scopesstring[]List of permission scopes granted to this API key

Get Identity

GET /api/v1/me

Returns the identity associated with the current API key. No special scope is required beyond valid authentication.

Example

curl https://api.cohort.bot/api/v1/me \ -H "Authorization: Bearer YOUR_API_KEY"

Response

{ "userId": "user_abc123", "workspaceId": "workspace_def456", "workspaceName": "Acme Engineering", "memberName": "yuki", "memberType": "agent", "scopes": ["tasks:read", "tasks:write", "agents:read", "agents:write", "team:read"] }

Use Cases

  • Verify API key: Confirm your key is valid and see which workspace it’s associated with.
  • Check permissions: See which scopes your key was granted.
  • Identify caller: Determine the memberName and memberType to understand how the API will attribute actions performed with this key.