> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resolve project identity from an API key

> Answers "which project does this API key belong to?" — the one thing `GET /v1/sdk/config` can't answer, since that route requires the caller to already know the `projectId` and rejects a mismatch. This is `zespan doctor`'s first call, and how it establishes project identity before anything else in the doctor run.

Authenticated with `x-api-key`, same as every other endpoint on this page. Returns identity and the project's resolved SDK config only — never a secret: no API key hash, no raw key, no provider credentials.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/sdk/whoami
openapi: 3.1.0
info:
  title: Zespan Public API
  version: 1.0.0
  description: >
    The Zespan Public API covers the endpoints that customers call directly or
    through the Zespan SDKs: trace ingestion (native and OpenTelemetry), prompt
    management, datasets and dataset runs, and the runtime guardrails check.

    All endpoints authenticate with a project API key sent in the `x-api-key`
    header. Create and manage API keys from the project settings in the Zespan
    dashboard.
servers:
  - url: https://api.zespan.com
    description: Zespan production API
security:
  - ApiKeyAuth: []
tags:
  - name: Ingestion
    description: Send traces and events to Zespan.
  - name: OpenTelemetry
    description: OTLP-compatible ingestion endpoints.
  - name: Prompts
    description: Manage versioned prompts and their labels, tags, and folders.
  - name: Datasets
    description: Read datasets and manage dataset runs used for experiments and scoring.
  - name: Guardrails
    description: Runtime guardrail evaluation.
  - name: SDK / CLI support
    description: >
      Small support endpoints consumed by the SDKs and @zespan/cli rather than
      called directly by application code.
  - name: Blast Radius
    description: >
      The prompt/agent/model/policy/evaluator/alert dependency graph backing the
      pre-release impact check and the evaluator-delete gate in the dashboard.
      Session-authenticated (dashboard cookie), not `x-api-key`.
  - name: Outcomes
    description: >
      Report business outcomes (a deflected ticket, an avoided refund, an SLA
      met) attributed to a trace, and read them back summarized by agent or
      model, joined to real trace cost. Backs the Value dashboard page. The
      ingest endpoint is `x-api-key`-authenticated like the rest of ingestion;
      the two read endpoints are session-authenticated (dashboard cookie) like
      Blast Radius.
  - name: Compliance
    description: >
      Generate audit-ready evidence documents (a per-agent Compliance Card, or
      SOC 2 control evidence) from recorded platform data, and re-verify a
      generated document's citations against live data. Session-authenticated
      (dashboard cookie), not `x-api-key`, gated by `compliance:read` /
      `compliance:generate` permissions and the Pro plan or above (the framework
      listing is the one exception — no project scope and no plan gate, since a
      customer deciding whether to upgrade needs to see what they'd get).
  - name: Models
    description: >
      Per-model usage, cost, latency, and error-rate rollups for a project,
      including the lifecycle overlay described under the Model Lifecycle tag.
      Session-authenticated (dashboard cookie), not `x-api-key`, gated by
      `dashboard:read`.
  - name: Model Lifecycle
    description: >
      Findings from the daily model deprecation scan, which matches models a
      project actually calls against a curated, bundled catalogue of
      provider-announced deprecation and retirement dates. Every figure on a
      finding (call volume, cost, affected agents/prompts, cost comparison
      against a named successor) is measured from real trace data — there is no
      quality-delta or regression-comparison endpoint, because nothing in this
      API invokes a model on the caller's behalf. Session-authenticated
      (dashboard cookie), not `x-api-key`: reading findings and the catalogue
      requires `dashboard:read`, dismissing a finding requires `alerts:manage`.
paths:
  /v1/sdk/whoami:
    get:
      tags:
        - SDK / CLI support
      summary: Resolve project identity from an API key
      description: >
        Answers "which project does this API key belong to?" — the one thing
        `GET /v1/sdk/config` can't answer, since that route requires the caller
        to already know the `projectId` and rejects a mismatch. This is `zespan
        doctor`'s first call, and how it establishes project identity before
        anything else in the doctor run.


        Authenticated with `x-api-key`, same as every other endpoint on this
        page. Returns identity and the project's resolved SDK config only —
        never a secret: no API key hash, no raw key, no provider credentials.
      operationId: sdkWhoami
      responses:
        '200':
          description: Project identity and resolved SDK config.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SdkWhoamiResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SdkWhoamiResponse:
      type: object
      description: Project identity and resolved SDK config for the authenticated API key.
      properties:
        projectId:
          type: string
          format: uuid
        projectName:
          type: string
          example: Checkout Agent
        orgId:
          type: string
          format: uuid
        configVersion:
          description: >-
            Monotonic version of the resolved SDK config, as an integer or
            string depending on how it was stored.
          oneOf:
            - type: integer
            - type: string
          example: 4
        config:
          type: object
          description: >
            The project's resolved SDK config — a free-form, server-pushed
            settings bag — plus two fields the CLI's `zespan doctor` reads
            directly: `pii` (the project's actual redaction policy) and
            `latestSdkVersion` (omitted entirely, not sent as null, when it
            can't be resolved).
          properties:
            pii:
              type: object
              properties:
                enabled:
                  type: boolean
                preset:
                  type: string
                  example: gdpr
            latestSdkVersion:
              type: string
              example: 1.8.2
          additionalProperties: true
      required:
        - projectId
        - projectName
        - orgId
        - configVersion
        - config
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
          example: Unauthorized
        code:
          type: string
          description: Machine-readable error code, when present.
          example: rate_limit_exceeded
      required:
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Project API key. Manage keys in the Zespan dashboard under project
        settings.

````