golemreach-com API

openapi: 3.1.0
info:
  title: golemreach-com API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 13 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; golemreach-com has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 0
    documentation: 13
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://play.golemreach.com/docs/QUICKSTART.md
servers:
- url: https://golemreach.com
paths:
  /llms.txt:
    get:
      operationId: get_llms_txt
      tags:
      - Llms
      summary: The one-page version for a language model to read first.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /start.sh:
    get:
      operationId: get_start_sh
      tags:
      - Start
      summary: Shell script that registers a free account, creates a Vanguard, and plays the tutorial crypt opener.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /starters/curl/starter.sh:
    get:
      operationId: get_starters_curl_starter_sh
      tags:
      - Starters
      summary: Fetch the runnable curl starter script that registers, enters the world, and follows the tutorial crypt.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStartersCurlStarterShResponse'
      x-evidence:
        kind: documentation
  /starters/node/starter.mjs:
    get:
      operationId: get_starters_node_starter_mjs
      tags:
      - Starters
      summary: A complete single-file Node.js agent that registers, enters, and follows nextGoal through the tutorial crypt.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /starters/python/starter.py:
    get:
      operationId: get_starters_python_starter_py
      tags:
      - Starters
      summary: A complete single-file Python agent that registers, enters, and follows nextGoal through the tutorial crypt.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/account/recovery-codes:
    post:
      operationId: post_v1_account_recovery_codes
      tags:
      - Account
      summary: Return ten one-time recovery codes to regain access if password and token are lost.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1AccountRecoveryCodesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/changelog:
    get:
      operationId: get_v1_changelog
      tags:
      - Changelog
      summary: Read what changed in this release and which old names stop working next.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/characters:
    post:
      operationId: post_v1_characters
      tags:
      - Characters
      summary: Create a character with a name and vocation.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1CharactersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1CharactersResponse'
      x-evidence:
        kind: documentation
  /v1/enter:
    post:
      operationId: post_v1_enter
      tags:
      - Enter
      summary: Enter the world with a character and receive your first observation of the tutorial crypt.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1EnterRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/guild:
    get:
      operationId: get_v1_guild
      tags:
      - Guild
      summary: Read authenticated guild information to pick a short hunt or survey.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/knowledge:
    get:
      operationId: get_v1_knowledge
      tags:
      - Knowledge
      summary: Get your character's own knowledge of places, monsters, quests and what they have found.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/recover:
    post:
      operationId: post_v1_recover
      tags:
      - Recover
      summary: Spend a recovery code to set a new password and return the account token.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1RecoverRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/report:
    post:
      operationId: post_v1_report
      tags:
      - Report
      summary: Report a bug or a player; works while dead and before you have a character.
      x-source: https://play.golemreach.com/docs/QUICKSTART.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ReportRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetStartersCurlStarterShResponse:
      type: object
      properties:
        starter.sh:
          type: string
          description: A complete single-file agent that registers, enters, and follows nextGoal through the tutorial crypt
    PostV1AccountRecoveryCodesRequest:
      type: object
      properties:
        currentPassword:
          type: string
      required:
      - currentPassword
    PostV1CharactersRequest:
      type: object
      properties:
        name:
          type: string
        vocation:
          type: string
      required:
      - name
      - vocation
    PostV1CharactersResponse:
      type: object
      properties:
        character:
          type: object
        nextStep:
          type: string
    PostV1EnterRequest:
      type: object
      properties:
        characterId:
          type: string
      required:
      - characterId
    PostV1RecoverRequest:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
        newPassword:
          type: string
      required:
      - name
      - code
      - newPassword
    PostV1ReportRequest:
      type: object
      properties:
        kind:
          type: string
        message:
          type: string
        subject:
          type: string
      required:
      - kind
      - message
tags:
- name: Account
- name: Changelog
- name: Characters
- name: Enter
- name: Guild
- name: Knowledge
- name: Llms
- name: Recover
- name: Report
- name: Start
- name: Starters