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

# Who am I

> The key's workspace, name, scopes and expiry, the workspace's plan and limits, and today's usage. Does not use shortlist credits.

Any valid key.



## OpenAPI

````yaml /openapi.json get /me
openapi: 3.1.0
info:
  title: Revcenter API
  version: v1
  description: >-
    Projects, searches, scored candidates and shortlists. Generated from the
    agent API's registry.
servers:
  - url: https://api.revcenter.ai/v1
security:
  - bearer: []
tags:
  - name: Login
  - name: Account
  - name: Actions
  - name: Reference
  - name: Projects
  - name: Searches
  - name: Scoring
  - name: Shortlists
  - name: Candidates
  - name: Health
paths:
  /me:
    get:
      tags:
        - Account
      summary: Who am I
      description: >-
        The key's workspace, name, scopes and expiry, the workspace's plan and
        limits, and today's usage. Does not use shortlist credits.


        Any valid key.
      operationId: get_me
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: >-
                Requests allowed this minute (the tighter of the key's and the
                workspace's).
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left this minute.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: When the minute resets, in Unix seconds.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Me'
                  meta:
                    $ref: '#/components/schemas/Meta'
              example:
                data:
                  workspace:
                    id: org_2xAmpLe
                    name: Acme Search Partners
                  key:
                    id: 8d5f0c1e-6a2b-4f3c-9d1e-7b6a5c4d3e21
                    name: Claude Code
                    prefix: rvc_live_RZnkjF1TIc...
                    scopes:
                      - projects:read
                      - projects:write
                      - searches:read
                      - searches:write
                      - shortlists:read
                      - shortlists:write
                    expires_at: '2027-01-15T00:00:00.000Z'
                  plan:
                    active: true
                    tier: growth
                    term: annual
                    expires_at: '2027-09-01T00:00:00.000Z'
                    credits_remaining: 37
                  limits:
                    requests_per_minute_per_key: 60
                    requests_per_minute_per_workspace: 120
                    max_keys: 5
                  usage_today:
                    requests: 41
                    searches: 2
                    running: 1
                meta:
                  request_id: req_01JABCDEF
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Me:
      type: object
      properties:
        workspace:
          type: object
          properties:
            id:
              type: string
            name:
              type:
                - string
                - 'null'
        key:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            prefix:
              type: string
            scopes:
              type: array
              items:
                type: string
            expires_at:
              type:
                - string
                - 'null'
        plan:
          type: object
          properties:
            active:
              type: boolean
            tier:
              type:
                - string
                - 'null'
            term:
              type:
                - string
                - 'null'
            expires_at:
              type:
                - string
                - 'null'
            credits_remaining:
              type:
                - integer
                - 'null'
        limits:
          type: object
          additionalProperties:
            type: number
        usage_today:
          type: object
          properties:
            requests:
              type: integer
            searches:
              type: integer
            running:
              type: integer
    Meta:
      type: object
      properties:
        request_id:
          type: string
        total:
          type: integer
          description: On lists that count everything that matched.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: 'Stable: every code is on the Errors page.'
            message:
              type: string
            details:
              type:
                - object
                - 'null'
              description: >-
                Structured specifics, when there are any (for example
                retry_after_seconds).
            request_id:
              type: string
        meta:
          $ref: '#/components/schemas/Meta'
      example:
        error:
          code: search_not_found
          message: No search with that id in this workspace.
          details: null
          request_id: req_01JABCDEF
        meta:
          request_id: req_01JABCDEF
  responses:
    Error:
      description: 'An error: one envelope everywhere. A 429 carries Retry-After.'
      headers:
        X-RateLimit-Limit:
          description: >-
            Requests allowed this minute (the tighter of the key's and the
            workspace's).
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left this minute.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: When the minute resets, in Unix seconds.
          schema:
            type: integer
        Retry-After:
          description: Seconds to wait (on 429 and 503).
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key from Settings → Usage → API (rvc_live_…).

````

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