> ## 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.

# Get world details

> Retrieve public details for a world, including related character, location, and region summaries.




## OpenAPI

````yaml /api-reference/openapi.yaml get /context/world/{game_id}/{world_id}
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:
  /context/world/{game_id}/{world_id}:
    get:
      tags:
        - Worlds
      summary: Get world details
      description: >
        Retrieve public details for a world, including related character,
        location, and region summaries.
      parameters:
        - name: game_id
          in: path
          required: true
          description: The unique identifier for the game.
          schema:
            type: string
            example: game123
        - name: world_id
          in: path
          required: true
          description: The unique identifier for the world.
          schema:
            type: string
            example: world456
        - name: session_id
          in: query
          description: (Optional) The player's session ID.
          required: false
          schema:
            type: string
            example: 60Z5aZjIuFlyYbjbZZKe
      responses:
        '200':
          description: World retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  world_id:
                    type: string
                    description: UID of the world.
                    example: world456
                  world:
                    $ref: '#/components/schemas/PublicWorld'
        '400':
          description: >
            Validation error - The request parameters did not match the required
            schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - The specified world was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message for the missing world.
                    example: World with ID world456 not found.
        '500':
          description: >
            Internal Server Error - An error occurred while retrieving the
            world.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - npcbuilder_auth: []
components:
  schemas:
    PublicWorld:
      type: object
      properties:
        id:
          type: string
          example: world456
        name:
          type: string
          example: Eldoria
        lore:
          type: string
          example: A world where magic and technology coexist.
        description:
          type: string
          example: A bright high-fantasy world.
        creatures:
          type: string
          example: Dragons, Elves
        similarWorlds:
          type: array
          items:
            type: string
            example: Middle Earth
        characters:
          type: array
          items:
            $ref: '#/components/schemas/PublicCharacterSummary'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/PublicLocationSummary'
        regions:
          type: array
          items:
            $ref: '#/components/schemas/PublicRegionSummary'
    ErrorResponse:
      type: object
      description: Standard error response schema.
      properties:
        message:
          type: string
          description: Detailed error message.
          example: An error occurred
    PublicCharacterSummary:
      type: object
      properties:
        id:
          type: string
          example: character789
        name:
          type: string
          example: Aragorn
        role:
          type: string
          example: protagonist
    PublicLocationSummary:
      type: object
      properties:
        id:
          type: string
          example: location789
        name:
          type: string
          example: Rivertown
        role:
          type: string
          example: Trade hub
        characters:
          type: array
          items:
            $ref: '#/components/schemas/PublicCharacterSummary'
    PublicRegionSummary:
      type: object
      properties:
        id:
          type: string
          example: region789
        name:
          type: string
          example: Mystic Forest
        locations:
          type: array
          items:
            $ref: '#/components/schemas/PublicLocationSummary'
        characters:
          type: array
          items:
            $ref: '#/components/schemas/PublicCharacterSummary'
  securitySchemes:
    npcbuilder_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````