Whoami

Markdown

The key, its creator, the limits and the endpoints.

Fields

  • 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.

Used by