> ## Documentation Index > Fetch the complete documentation index at: https://docs.nohead.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the authenticated principal > The user or API key making the request. API key clients use it to discover their project and scopes. ## OpenAPI ````yaml /openapi.json get /v1/me openapi: 3.1.1 info: title: Nohead API version: 1.0.0 summary: Programmable content and data API. contact: name: Nohead email: hello@nohead.io url: https://nohead.io description: > The Nohead API manages projects, collections (your data models), their fields, and records (your content), with full version history. ## Authentication Send `Authorization: Bearer `. Servers, CI and agents use a project API key (`nohead_sk_...`, or `nohead_pk_...` for a published-only key; created in the web app under API keys) with scopes such as `records:read` or `schema:write`. Organization, project, member and API key management need a person signed in to the web app and are not available to API keys. ## Resources and IDs Every object has an `object` type, and every resource with an identity of its own an opaque, prefixed `id` (`col_`, `fld_`, `rec_`, ...). Record values live under `data`, keyed by each field's `key`. Timestamps are ISO 8601 in UTC. Deleting a record, collection, field, asset or webhook is soft: it can be restored until its `purge_after`. ## Lists Lists return `{ "data": [...], "meta": { "next_cursor", "has_more" } }`. Pass `limit` (1-100) and `cursor` to page, and `sort` (prefix `-` for descending). Records also take `filter[]=value`, `filter[published_at][exists]=true` and `expand=`. ## Errors Errors share one envelope: `{ "error": { "type", "message", "request_id", "details" } }`. `details` lists field-level problems as `{ "field", "code", "message" }`. Include the `request_id` when asking for support. ## Safe retries and concurrent edits Send `Idempotency-Key` on any `POST`, `PUT`, `PATCH` or `DELETE` to make retrying it safe: the first result is stored for 24 hours and returned again for the same request. Record responses carry the record's revision as an `ETag`; send it back as `If-Match` to update only if nobody changed the record in the meantime (`412` otherwise). ## History Every change to a record is a revision, attributed to the person or API key that made it: record revisions can be listed, diffed and reverted, and collections keep a schema history. Send `Nohead-Change-Note` to record why a change was made. Changes that rewrite existing values (such as a field's type) are explicit, previewable field migrations. How long revisions are kept depends on the organization's plan. Older ones are removed, but every record keeps its first revision and its last 10; `history_pruned_through` says how far history was removed. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.nohead.io description: Production security: - apiKey: [] tags: - name: records x-group: Records description: Content entries, one at a time or many at once. - name: publishing x-group: Publishing description: Making records live, now or at a set time, and taking them down. - name: revisions x-group: Revisions description: A record's history, comparing two revisions, and going back to one. - name: drafts x-group: Drafts description: Changes to a record that wait to be merged into it, now or at a set time. - name: collections x-group: Collections description: User-defined data models. - name: schema-changes x-group: Schema changes description: A collection's schema history, and its schema at any version. - name: fields x-group: Fields description: Field definitions of a collection. - name: migrations x-group: Field migrations description: Explicit field changes that rewrite existing record values, with previews. - name: assets x-group: Assets description: Files stored for a project, uploaded directly to storage. - name: search x-group: Search description: Full-text search in collections and across a project. - name: webhooks x-group: Webhooks description: Event notifications sent to your URLs, and the secrets that sign them. - name: deliveries x-group: Webhook deliveries description: Each event sent to a webhook, its attempts, and retrying it. - name: audit x-group: Activity log description: The append-only trail of who changed what, through which client. - name: system x-group: System description: Service status, the caller, and its feature flags. paths: /v1/me: get: tags: - system summary: Get the authenticated principal description: | The user or API key making the request. API key clients use it to discover their project and scopes. operationId: me_get responses: '200': description: The authenticated principal. content: application/json: schema: $ref: '#/components/schemas/Principal' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' x-codeSamples: - lang: typescript label: TypeScript source: | import { Nohead } from "@nohead/sdk" const nohead = new Nohead() const result = await nohead.me.get() - lang: python label: Python source: | from nohead import Nohead nohead = Nohead() result = nohead.me.get() - lang: ruby label: Ruby source: | require "nohead" nohead = Nohead::Client.new result = nohead.me.get components: schemas: Principal: type: object additionalProperties: false required: - object - type - user - api_key properties: object: const: principal type: type: string enum: - user - api_key user: oneOf: - type: 'null' - type: object additionalProperties: false required: - id - email - name - staff properties: id: type: string email: type: string name: type: - string - 'null' staff: type: boolean description: Whether the user is Nohead staff. api_key: oneOf: - type: 'null' - type: object additionalProperties: false required: - id - name - scopes - published_only - project_id - expires_at properties: id: type: string name: type: string scopes: type: array items: $ref: '#/components/schemas/ApiKeyScope' published_only: $ref: '#/components/schemas/PublishedOnly' project_id: type: string expires_at: $ref: '#/components/schemas/NullableTimestamp' ApiKeyScope: type: string description: >- What a project API key may do. `records:write` also publishes, unpublishes and schedules records. `webhooks:read` includes delivery payloads and `webhooks:write` can subscribe an endpoint to every event, so both give access to the record, schema and asset data in events, unpublished records included; published-only keys cannot have them. enum: - records:read - records:write - schema:read - schema:write - assets:read - assets:write - search:read - webhooks:read - webhooks:write - audit:read PublishedOnly: type: boolean default: false description: >- The key sees published records only, for sites and apps: lists, reads, search and expanded relations leave out unpublished and deleted records, and history is not available. Only read scopes (records:read, schema:read, assets:read, search:read) are allowed. NullableTimestamp: type: - string - 'null' format: date-time Error: type: object additionalProperties: false required: - error properties: error: type: object additionalProperties: false required: - type - message - request_id properties: type: $ref: '#/components/schemas/ErrorType' message: type: string request_id: $ref: '#/components/schemas/RequestId' details: type: array items: $ref: '#/components/schemas/ErrorDetail' RequestId: type: string pattern: ^req_[A-Za-z0-9]+$ examples: - req_01J9ZQ3F8X5W2K7M4N6P0R1S2T ErrorType: type: string enum: - invalid_request - authentication_error - plan_limit_exceeded - authorization_error - not_found - conflict - precondition_failed - validation_error - rate_limited - internal_error - service_unavailable ErrorDetail: type: object additionalProperties: false required: - code - message properties: field: type: string description: Key of the offending field or parameter, when applicable. code: type: string description: Machine-readable error code, e.g. `required`. message: type: string usage: type: integer description: Current usage, for `plan_limit` details. limit: type: integer description: The plan's limit, for `plan_limit` details. current_revision: type: integer description: The resource's current revision, for `revision_mismatch` details. record_id: type: string description: The record that already has the value, for `taken` details. draft_id: type: string description: The record's draft, for `draft_exists` and `draft_pending` details. responses: Unauthorized: description: Authentication is missing or invalid. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: > Too many requests for this API key or user (or, with failing credentials, this IP address). A published-only key is counted per client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key` are safe. On the Free plan, an organization's API keys are also refused once its API requests reach the month's limit, with a `plan_limit` detail (`field` `api_requests`, `usage` and `limit`), until the next month (UTC) or an upgrade. headers: X-Request-Id: $ref: '#/components/headers/RequestId' Retry-After: description: Seconds to wait before retrying. schema: type: integer RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/Error' headers: RequestId: description: Unique identifier for the request, also echoed in error bodies. schema: $ref: '#/components/schemas/RequestId' RateLimitLimit: description: >- Requests allowed in the current window. Sent on every authenticated response. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Seconds until the window resets. schema: type: integer securitySchemes: apiKey: type: http scheme: bearer description: | Project-scoped API key, e.g. `nohead_sk_k7fz0a9c3m2q_`, or `nohead_pk_…` for a published-only key. Used by servers, CI, the CLI and coding agents. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.