For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETWhoami
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referenceauth

Whoami

GET
/api/v1/auth/whoami
GET
/api/v1/auth/whoami
$curl https://api.onepin.ai/api/v1/auth/whoami \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": {
3    "auth_kind": "clerk",
4    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5    "scopes": [
6      "workflows:read",
7      "voices:write",
8      "uploads:write"
9    ],
10    "workspace_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
11    "api_key_id": null
12  },
13  "meta": {
14    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
15    "timestamp": "2024-01-15T09:30:00Z"
16  }
17}

Return the resolved Clerk or API-key authentication context.

Was this page helpful?
Previous

List Api Keys

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error