SignupApiKey

  • Metadata about an API key. The secret itself is never included here.

    • createdAt
      Type: string
      required

      ISO 8601 timestamp of when the key was created.

    • id
      Type: string
      required

      Unique key identifier (prefixed key_). Use it to revoke the key.

    • keyPrefix
      Type: string
      required

      The non-secret prefix of the key, safe to display so you can tell keys apart. The full secret is only ever returned once, at creation.

    • lastUsedAt
      Type: string | null
      required

      ISO 8601 timestamp the key was last used to authenticate, or null if never.

    • name
      Type: string
      required

      Human-readable label for the key.

    • revokedAt
      Type: string | null
      required

      ISO 8601 timestamp the key was revoked, or null if still active.

    • secret
      Type: string
      required

      The full API-key secret. Shown exactly once, at creation — it is stored only as a hash and cannot be retrieved again. Save it now and send it as Authorization: Bearer <secret>.