---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Sylphx Access whoami"
description: "`access.whoami` (GET /v1/whoami): Returns the caller: the principal and the scope of the key or token that authenticated this request."
type: reference
product: platform
summary: "Returns the caller: the principal and the scope of the key or token that authenticated this request."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Returns the caller: the principal and the scope of the key or token that authenticated this request. Clients fill their org, project, and env defaults from it; every valid key may call it, whatever its scopes.

- **Path** `GET https://api.sylphx.com/v1/whoami`
- **Scope** `access:whoami`
- **Effect** `read` — nothing is written.
- **Service** Sylphx Access
- **Publishable key** callable

## Request

The call carries nothing but its path.

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `principal` | `string` | The authenticated principal, `principal_<cell><ulid>`. Output only. |
| `api_key` | `string` | The API key that authenticated the request; empty for an OAuth token. Output only. |
| `org` | `string` | The org the credential is scoped to. Output only. |
| `project` | `string` | The project the credential is scoped to; empty for an org-wide credential. Output only. |
| `env` | `string` | The environment the credential is scoped to; empty above an environment. Output only. |
| `scopes` | `string[]` | The credential's scopes, `<service>:<action>`. Output only. |
| `api_version` | `string` | The API version date applied to this request; empty before the first version. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/whoami" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.access.whoami({})
```

**Rust**

```rust
let response = sx.access().whoami(Default::default()).await?;
```

**CLI**

```bash
sylphx access whoami
```

**MCP**

```json
{ "method_id": "access.whoami", "args": {} }
```