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

# Get me

> The API key, the user it acts as (the person who created it) and the workspace it belongs to. Works with any valid key.



## OpenAPI

````yaml /openapi.yaml get /me
openapi: 3.1.0
info:
  title: AeoNut API
  version: '1.0'
  description: >
    Read your workspace's AI visibility, content map and content data. Every
    response is wrapped in

    `{code, messages, data}`. Rates are fractions between 0 and 1 unless a field
    says otherwise.
servers:
  - url: https://services.deepsmith.ai/core/api/external/v1
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Me
  - name: Workspace
  - name: AI visibility
  - name: Content map
  - name: Content
  - name: IQ
paths:
  /me:
    get:
      tags:
        - Me
      summary: Get me
      description: >-
        The API key, the user it acts as (the person who created it) and the
        workspace it belongs to. Works with any valid key.
      responses:
        '200':
          description: Key details
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          key:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                              name:
                                type: string
                              prefix:
                                type: string
                                example: ds_live_1a2b
                              scopes:
                                type: array
                                items:
                                  $ref: '#/components/schemas/Scope'
                              expires_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                          user:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                              name:
                                type: string
                              email:
                                type: string
                              avatar:
                                type:
                                  - string
                                  - 'null'
                          workspace:
                            type: object
                            description: Full details at `GET /workspace`.
                            properties:
                              id:
                                type: string
                                format: uuid
                              name:
                                type: string
              example:
                code: 4020
                messages: Key details
                data:
                  key:
                    id: 9f2a3b4c-1d2e-4f5a-8b6c-7d8e9f0a1b2c
                    name: Reporting script
                    prefix: ds_live_1a2b
                    scopes:
                      - visibility:read
                      - contentmap:read
                      - content:read
                      - workspace:read
                    expires_at: null
                  user:
                    id: 3b4c5d6e-7f80-4a1b-9c2d-3e4f5a6b7c8d
                    name: Jordan Lee
                    email: jordan@acme.com
                    avatar: null
                  workspace:
                    id: 7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f
                    name: Acme
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Envelope:
      type: object
      properties:
        code:
          type: integer
          description: AeoNut status code
        messages:
          type: string
        data: {}
    Scope:
      type: string
      enum:
        - workspace:read
        - visibility:read
        - contentmap:read
        - content:read
        - iq:read
  responses:
    Unauthorized:
      description: Missing (`code` 4021), invalid, revoked or expired (`code` 4022) API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            code: 4022
            messages: Invalid, revoked or expired API key.
            data: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer API Key Value`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.