Gemmein API

openapi: 3.1.0
info:
  title: Gemmein API
  version: '2026-11-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-09: 11 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Gemmein has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 11
    pages-with-code: 0
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.gemmein.com/reference
  - https://docs.gemmein.com/credits
  - https://docs.gemmein.com/ai/runs
  - https://docs.gemmein.com/relays/receivers
  - https://docs.gemmein.com/relays/actions
  - https://docs.gemmein.com/errors
  - https://docs.gemmein.com/changes.txt
paths:
  /ai/run:
    post:
      operationId: post_ai_run
      tags:
      - Ai
      summary: Starts a run on tool for the event's person, as if they called POST /ai/run/<tool>.
      x-source: https://docs.gemmein.com/relays/actions
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /ai/run/{tool}:
    post:
      operationId: post_ai_run_tool
      tags:
      - Ai
      summary: Image, audio and video runs
      description: Starts a run for the specified AI tool (kind generate or transcribe). The server reserves the tool's ceiling, composes the
        provider request, and returns a 202 response containing the run.
      x-source: https://docs.gemmein.com/ai/runs
      parameters:
      - name: tool
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAiRunToolResponse'
      x-evidence:
        kind: documentation
  /auth/credits:
    get:
      operationId: get_auth_credits
      tags:
      - Auth
      summary: Credits
      x-source: https://docs.gemmein.com/credits
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthCreditsResponse'
      x-evidence:
        kind: documentation
  /hooks/{appid}/{name}:
    post:
      operationId: post_hooks_appid_name
      tags:
      - Hooks
      summary: Webhook receivers, whose secret it is, the map, the filter and payment time.
      description: 'Receivers are webhook URLs that accept POST requests. The receiver validates signatures or tokens according to the chosen
        scheme and stores the event. Successful storage returns HTTP 200 with `{ received: true, eventId }`. Various error codes are returned
        for unknown receiver, bad signature, body too large, invalid JSON, rate limiting, and storage failures.'
      x-source: https://docs.gemmein.com/relays/receivers
      parameters:
      - name: appid
        in: path
        required: true
        schema:
          type: string
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHooksAppidNameResponse'
      x-evidence:
        kind: documentation
  /manage/server-keys:
    post:
      operationId: post_manage_server_keys
      tags:
      - Manage
      summary: Server keys
      x-source: https://docs.gemmein.com/changes.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /server/inbox/threads:
    get:
      operationId: get_server_inbox_threads
      tags:
      - Server
      summary: List inbox threads
      x-source: https://docs.gemmein.com/reference
      parameters:
      - name: unanswered
        in: query
        required: false
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServerInboxThreadsResponse'
      x-evidence:
        kind: documentation
  /server/inbox/threads/{id}:
    get:
      operationId: get_server_inbox_threads_id
      tags:
      - Server
      summary: Get inbox thread
      x-source: https://docs.gemmein.com/reference
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServerInboxThreadsIdResponse'
      x-evidence:
        kind: documentation
  /server/inbox/threads/{id}/reply:
    post:
      operationId: post_server_inbox_threads_id_reply
      tags:
      - Server
      summary: Reply to inbox thread
      x-source: https://docs.gemmein.com/reference
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostServerInboxThreadsIdReplyRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostServerInboxThreadsIdReplyResponse'
      x-evidence:
        kind: documentation
  /server/people:
    post:
      operationId: post_server_people
      tags:
      - Server
      summary: Invite a person by email
      x-source: https://docs.gemmein.com/reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostServerPeopleRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostServerPeopleResponse'
      x-evidence:
        kind: documentation
  /server/people/{id}/credits/spend:
    post:
      operationId: post_server_people_id_credits_spend
      tags:
      - Server
      summary: Credits
      x-source: https://docs.gemmein.com/credits
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostServerPeopleIdCreditsSpendRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostServerPeopleIdCreditsSpendResponse'
      x-evidence:
        kind: documentation
  /server/test-session:
    post:
      operationId: post_server_test_session
      tags:
      - Server
      summary: Server keys
      x-source: https://docs.gemmein.com/changes.txt
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAiRunToolResponse:
      type: object
      properties:
        run:
          type: string
          description: The created run object returned immediately with status 202.
    GetAuthCreditsResponse:
      type: object
      properties:
        balance:
          type: string
        reserved:
          type: string
        expiring:
          type: string
    PostHooksAppidNameResponse:
      type: object
      properties:
        received:
          type: boolean
          description: Always true when the event is stored.
        eventId:
          type: string
          description: The identifier of the stored event.
    GetServerInboxThreadsResponse:
      type: object
      properties:
        threads:
          type: array
          description: Array of thread objects
        total:
          type: integer
          description: Total number of threads
        unanswered:
          type: integer
          description: Count of unanswered threads
        capped:
          type: boolean
          description: Whether the result was capped
    GetServerInboxThreadsIdResponse:
      type: object
      properties:
        thread:
          type: object
          description: Thread metadata
        messages:
          type: array
          description: Array of message objects (up to 50, newest first)
        earlierMessages:
          type: array
          description: Older messages not included in the main list
        aiMayReply:
          type: object
          description: AI reply capability info
    PostServerInboxThreadsIdReplyRequest:
      type: object
      properties:
        text:
          type: string
      required:
      - text
    PostServerInboxThreadsIdReplyResponse:
      type: object
      properties:
        message:
          type: object
          description: The created reply message
    PostServerPeopleRequest:
      type: object
      properties:
        email:
          type: string
      required:
      - email
    PostServerPeopleResponse:
      type: object
      properties:
        person:
          type: object
          description: The invited person data
        created:
          type: boolean
          description: True if the person was created, false if already existed
    PostServerPeopleIdCreditsSpendRequest:
      type: object
      properties:
        amount:
          type: integer
        reason:
          type: string
        key:
          type: string
    PostServerPeopleIdCreditsSpendResponse:
      type: object
      properties:
        ok:
          type: boolean
        spent:
          type: integer
        deduped:
          type: boolean
        balance:
          type: object
          description: contains before and after
        balance.before:
          type: integer
        balance.after:
          type: integer
        event:
          type: object
        event.id:
          type: string
        event.reason:
          type: string
        event.actor:
          type: string
  securitySchemes:
    API_key:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://docs.gemmein.com/console/api-keys
tags:
- name: Ai
- name: Auth
- name: Hooks
- name: Manage
- name: Server
security:
- API_key: []