Hugging Face · Example Payload

Hugging Face Whoami Example

Hugging Face Whoami Example is an example object payload from Hugging Face, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "whoami",
  "method": "GET",
  "path": "/whoami-v2",
  "summary": "Get Current User Information",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Whoami200Example",
      "example": {
        "type": "example_value",
        "id": "abc123",
        "name": "Example Title",
        "fullname": "example_value",
        "email": "user@example.com",
        "emailVerified": "user@example.com",
        "plan": "example_value",
        "canPay": true,
        "avatarUrl": "https://www.example.com",
        "orgs": [
          {
            "name": "Example Title",
            "fullname": "example_value",
            "email": "user@example.com",
            "plan": "example_value",
            "avatarUrl": "https://www.example.com",
            "isEnterprise": true
          }
        ],
        "auth": {
          "accessToken": {
            "displayName": "example_value",
            "role": "example_value"
          }
        }
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "name": "Whoami401Example",
      "example": {
        "error": "example_value",
        "statusCode": 10
      }
    }
  ]
}