SceniqDevelopers

whoami

Who this key belongs to, plus endpoints and limits.

GET/v1/me
MCP tool whoamiScope: readStableSince 2026-09-17
Markdown

Call first. Returns the creator this key is bound to, the key's scopes, the request limits, and the exact URLs for the REST API, the MCP endpoint and photo uploads.

curl "https://sceniq.earth/api/v1/me" \
  -H "Authorization: Bearer $SCENIQ_API_KEY"

Returns

200 OK with Whoami: The key, its creator, the limits and the endpoints.

  • creatorobjectrequired

    The creator this key is bound to.

    Show 4 fields
    • creatorIdstring · creator idrequired

      The creator's id.

    • slugstringrequired

      The creator's URL slug.

    • displayNamestringrequired

      The public brand name.

    • rolestringrequired

      The key owner's role on the account.

      ownereditor
  • keyobjectrequired

    The key.

    Show 2 fields
    • namestringrequired

      The key's name.

    • scopesarray of stringsrequired

      What the key may do.

      readwritepublish
  • limitsobjectrequired

    Request limits.

    Show 4 fields
    • requestsPerMinutePerKeynumberrequired

      Requests per minute for this key.

    • requestsPerHourPerCreatornumberrequired

      Requests per hour across the creator's keys.

    • uploadsPerMinutePerKeynumberrequired

      Photo uploads per minute for this key (a batch counts each file).

    • maxUploadBytesnumberrequired

      The largest photo accepted, in bytes.

  • endpointsobjectrequired

    The URLs to call, on the Sceniq domain.

    Show 7 fields
    • reststringrequired

      REST base URL.

    • mcpstringrequired

      MCP endpoint.

    • uploadstringrequired

      Photo upload.

    • uploadBatchstringrequired

      Batch photo upload.

    • openapistringrequired

      OpenAPI document.

    • skillstringrequired

      The authoring guide as a SKILL.md.

    • docsstringrequired

      The developer page, with the way into these docs.

  • directEndpointsobject or nullrequired

    The backend origin the Sceniq URLs proxy to, for harnesses without the proxy.

    Show 5 fields
    • reststringrequired

      REST base URL.

    • mcpstringrequired

      MCP endpoint.

    • uploadstringrequired

      Photo upload.

    • uploadBatchstringrequired

      Batch photo upload.

    • openapistringrequired

      OpenAPI document.

  • dashboardobjectrequired

    Studio links.

    Show 1 field
    • settingsUrlstringrequired

      Studio settings, where keys are made.

  • authoringGuideVersionstringrequired

    The authoring guide's version; reload it when it changes.

  • publishingstringrequired

    What this key may publish, in plain words.

Response 200
{
  "creator": {
    "creatorId": "k97c2m4vx8r1q0d6s5t3n9p2w7y4h8b1",
    "slug": "mara-lindgren",
    "displayName": "Mara Lindgren",
    "role": "owner"
  },
  "key": {
    "name": "Claude Code on the laptop",
    "scopes": [
      "read",
      "write"
    ]
  },
  "limits": {
    "requestsPerMinutePerKey": 300,
    "requestsPerHourPerCreator": 5000,
    "uploadsPerMinutePerKey": 60,
    "maxUploadBytes": 6291456
  },
  "endpoints": {
    "rest": "https://sceniq.earth/api/v1",
    "mcp": "https://sceniq.earth/api/mcp",
    "upload": "https://sceniq.earth/api/v1/media/upload",
    "uploadBatch": "https://sceniq.earth/api/v1/media/upload-batch",
    "openapi": "https://sceniq.earth/api/v1/openapi.json",
    "skill": "https://sceniq.earth/developers/skill.md",
    "docs": "https://sceniq.earth/developers"
  },
  "directEndpoints": {
    "rest": "https://quiet-heron-512.convex.site/v1",
    "mcp": "https://quiet-heron-512.convex.site/mcp",
    "upload": "https://quiet-heron-512.convex.site/v1/media/upload",
    "uploadBatch": "https://quiet-heron-512.convex.site/v1/media/upload-batch",
    "openapi": "https://quiet-heron-512.convex.site/v1/openapi.json"
  },
  "dashboard": {
    "settingsUrl": "https://creators.sceniq.earth/settings"
  },
  "authoringGuideVersion": "2026-09-30.3",
  "publishing": "This key cannot publish. A new guide always ends with two clicks only the creator makes in the studio: Publish guide and Publish sales page; get_guide_readiness handoff lists what is left with its links. Hand the creator the reviewUrl, or ask them to mint a key with the publish option for publish_changes on a live guide."
}

Errors

Every error is { error: { code, message } }. Act on the code.

  • 401unauthenticatedThe request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
  • 401invalid_api_keyThe key is unknown, revoked or expired.
  • 403forbiddenThe key belongs to a creator account that is no longer active.
  • 429rate_limitedOver a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
  • 500internal_errorAn unexpected failure. The message is hidden on purpose.