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

# Get the caller

> Returns who the request acts as. A session acts as the signed-in member, with their role in their organization. An API key acts as an admin and reports the person who created it.



## OpenAPI

````yaml /reference/openapi.yaml get /me
openapi: 3.1.0
info:
  title: Antigen API
  version: v1
  description: >-
    Work with the same agents, runs, and resources your team uses in Antigen.
    Requests and responses use camelCase fields. List endpoints return arrays.
    See the [overview](/reference) for authentication, updates, and errors.
servers:
  - url: https://api.antigen.sh/v1
security:
  - ApiKeyAuth: []
  - SessionAuth: []
tags:
  - name: Agents
    description: Retrieve, compose, and register agent configurations.
  - name: Models
    description: Models available to agents in your organization.
  - name: Targets
    description: Submit testing scope for human approval.
  - name: Runs
    description: Execute agents and control their work.
  - name: Vulnerabilities
    description: Track weaknesses, remediation, status, and assignment.
  - name: Evidence
    description: Read supporting file metadata and retrieve file contents.
  - name: Reports
    description: Read and export captured engagement results.
  - name: Human tasks
    description: Ask people for help and follow their responses.
  - name: Hooks
    description: Connect status and assignment changes to your own service.
  - name: Asset Map
    description: Read your organization’s infrastructure graph.
  - name: Integrations
    description: Inspect and disconnect provider connections.
  - name: Team
    description: List the people vulnerabilities can be assigned to.
  - name: API keys
    description: Create and revoke credentials for automation.
  - name: Account
    description: Identify the caller and end CLI sessions.
paths:
  /me:
    get:
      tags:
        - Account
      summary: Get the caller
      description: >-
        Returns who the request acts as. A session acts as the signed-in member,
        with their role in their organization. An API key acts as an admin and
        reports the person who created it.
      operationId: getMe
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          $ref: '#/components/responses/Error401'
        '429':
          $ref: '#/components/responses/Error429'
components:
  schemas:
    Me:
      type: object
      properties:
        user:
          type: object
          description: The signed-in member, or for an API key the person who created it.
          properties:
            email:
              type: string
            name:
              type: string
          required:
            - email
            - name
          additionalProperties: false
        org:
          type: object
          properties:
            id:
              type: string
              minLength: 1
            name:
              type: string
            slug:
              type: string
          required:
            - id
            - name
            - slug
          additionalProperties: false
        role:
          type: string
          description: The role requests act with. API keys are always `admin`.
          enum:
            - admin
            - member
            - read_only
        credential:
          type: string
          description: Which credential authenticated the request.
          enum:
            - session
            - apiKey
      required:
        - user
        - org
        - role
        - credential
      additionalProperties: false
      example:
        user:
          email: alex@example.com
          name: Alex Kim
        org:
          id: org_123
          name: Example
          slug: example
        role: member
        credential: session
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable error code.
            message:
              type: string
              description: Description of the problem.
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      example:
        error:
          code: invalid_request
          message: The target value is required.
  responses:
    Error401:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Supply a valid API key or session token.
    Error429:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Retry after the interval in Retry-After.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key from your organization, for CI pipelines and other automated
        systems. Supply the value directly, without a Bearer prefix. A key acts
        as an admin of its organization. When a request carries both a key and a
        session, the key is used.
    SessionAuth:
      type: http
      scheme: bearer
      description: >-
        Session token from `antigen login`, sent in the `Authorization` header
        with the `Bearer` scheme. The request acts as the signed-in member, with
        their own role in their organization. Sessions stop working when the
        member is deactivated.

````

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