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

# Retrieve session information

> Retrieve details of an existing session using the session key, game ID, and player ID.




## OpenAPI

````yaml /api-reference/openapi.yaml get /sessionmanager
openapi: 3.0.3
info:
  title: NPC Builder - API
  description: >
    This is the latest NPC Builder API specification that defines a
    comprehensive, production-ready API for NPC Builder. The API is divided into
    three primary services:


    **Interactions Service**  
      - **Purpose:** Enables dynamic, context-aware conversations between players and NPC characters.


    **Context Service**  
      - **Purpose:** Manages in-game entities to build and maintain immersive game environments.
      - **Includes:**  
        - **Worlds:** Create, update, and delete game worlds.
        - **Regions:** Define and manage distinct regions within a world.
        - **Locations:** Handle specific locations within regions.
        - **Characters:** Manage the lifecycle (creation, updating, deletion) of NPC characters.


    **Sessions Service**  
      - **Purpose:** Manages player sessions to maintain game context and track interactions.


    Overall, this specification serves as a detailed guide to leveraging NPC
    Builder’s services—empowering developers to build rich, interactive
    experiences while efficiently managing game contexts and entities.
        _You must stick to the data structure defined, otherwise you may encounter unhandled errors_


    **Please check the schemas of each request to find the allowed values for
    certain properties.**


    _Technical Limitations: Character's knowledge and relationships updating and
    deleting are not available through the API. They must be managed through our
    app's frontend._


    Some useful links:

    - [Our website](https://npcbuilder.com)

    - [The App](https://app.npcbuilder.com)
  termsOfService: https://npcbuilder.com/terms-and-conditions/
  contact:
    email: support@npcbuilder.com
  version: 1.6.0
servers:
  - url: https://app.npcbuilder.com/api
    description: Production API for context, sessions, and non-interaction endpoints
security: []
tags:
  - name: Interactions
    description: Manage your NPCs text conversations and interactive responses.
  - name: Characters
    description: Manage characters in your game including creation, update, and deletion.
  - name: Worlds
    description: Create and manage immersive worlds for your game.
  - name: Regions
    description: Define and manage regions within your worlds.
  - name: Locations
    description: Manage specific locations within regions of your game.
  - name: Sessions
    description: Create, retrieve, and delete player sessions for enhanced game management.
paths:
  /sessionmanager:
    get:
      tags:
        - Sessions
      summary: Retrieve session information
      description: >
        Retrieve details of an existing session using the session key, game ID,
        and player ID.
      parameters:
        - in: query
          name: session_key
          description: The session key identifying the session.
          schema:
            type: string
            pattern: ^[a-zA-Z0-9_-]+$
            maxLength: 50
          required: true
          example: campaign_nightfall
        - in: query
          name: game_id
          description: The unique identifier for the game.
          schema:
            type: string
            maxLength: 50
          required: true
          example: game_12345
        - in: query
          name: player_id
          description: The unique identifier for the player.
          schema:
            type: string
            format: uuidv4
          required: true
          example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: Session retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Confirmation message with session details.
                    example: 'Session for key: campaign_nightfall with id: ABC123'
                  session_id:
                    type: string
                  session_key:
                    type: string
                  player_id:
                    type: string
                    format: uuidv4
        '404':
          description: |
            Not Found – No session matches the provided details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Message indicating the session was not found.
                    example: 'Session for key: campaign_nightfall not found'
        '500':
          description: >
            Internal Server Error – An error occurred while retrieving the
            session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - npcbuilder_auth: []
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response schema.
      properties:
        message:
          type: string
          description: Detailed error message.
          example: An error occurred
  securitySchemes:
    npcbuilder_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````