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

# Set lead

> Make a plain session the Lead (terminal), which saves it and gives it the Lead's brief. Answer the offer to bring it back (asked: true; POST /terminals with resume and lead: true is what Bring back sends). With board: true or false, give or take away its permission to move the board. With starts and total, give it permission to start tickets while fewer than starts tasks are building (1 to one under the WIP limit), total in all (1 to 20), or take it away (starts: 0). With refresh: true or false, start or stop Refresh the Lead. With "lead": true, as Settings sends, a grant goes only to the session that is the Lead now, and is refused with not_lead otherwise, so a page that has not seen another session made the Lead does not make the old one the Lead again.

Tokens: the relay key only.

From docs/manual/relay.html#routes.



## OpenAPI

````yaml https://raw.githubusercontent.com/bfalkowski/Building58/main/docs/openapi.json post /channels/{channel}/terminals/lead
openapi: 3.1.0
info:
  title: Building58 relay
  version: 2.0.0
  description: >-
    The relay passes commands to a world's page and runs the room: tickets,
    tasks, sessions and reviews. It answers this computer only. Each route's
    description is the manual's, from docs/manual/relay.html, where the fields,
    the tokens and the errors are.
  license:
    name: PolyForm Noncommercial 1.0.0
    identifier: PolyForm-Noncommercial-1.0.0
servers:
  - url: http://localhost:8787
    description: The relay on this computer. npm run office starts it on 8787.
security:
  - relayKey: []
  - relayKeyQuery: []
  - sessionToken: []
tags:
  - name: calls
    description: 'Calls any caller uses: commands, events and the page.'
  - name: autopilot
  - name: chat
  - name: checkouts
  - name: floor
  - name: games
  - name: huddle
  - name: needs-you
  - name: officers
  - name: old-relays
  - name: play
  - name: pr-watch
  - name: ready
  - name: reviews
  - name: rounds
  - name: settings
  - name: tasks
  - name: terminals
  - name: tickets
  - name: update
paths:
  /channels/{channel}/terminals/lead:
    post:
      tags:
        - terminals
      summary: Set lead
      description: >-
        Make a plain session the Lead (terminal), which saves it and gives it
        the Lead's brief. Answer the offer to bring it back (asked: true; POST
        /terminals with resume and lead: true is what Bring back sends). With
        board: true or false, give or take away its permission to move the
        board. With starts and total, give it permission to start tickets while
        fewer than starts tasks are building (1 to one under the WIP limit),
        total in all (1 to 20), or take it away (starts: 0). With refresh: true
        or false, start or stop Refresh the Lead. With "lead": true, as Settings
        sends, a grant goes only to the session that is the Lead now, and is
        refused with not_lead otherwise, so a page that has not seen another
        session made the Lead does not make the old one the Lead again.


        Tokens: the relay key only.


        From docs/manual/relay.html#routes.
      operationId: setLead
      parameters:
        - name: channel
          in: path
          required: true
          description: >-
            The channel, such as office: 1 to 64 letters, numbers, dashes or
            underscores.
          schema:
            type: string
            pattern: ^[\w-]{1,64}$
      requestBody:
        required: false
        description: JSON. The fields are in the description.
        content:
          application/json:
            schema:
              type: object
      responses:
        2XX:
          description: Done.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ok'
        default:
          $ref: '#/components/responses/Problem'
components:
  schemas:
    Ok:
      type: object
      properties:
        ok:
          const: true
      required:
        - ok
      additionalProperties: true
    Problem:
      type: object
      properties:
        ok:
          const: false
        error:
          type: string
          description: A short code, such as bad_param, forbidden or not_found.
        message:
          type: string
          description: What went wrong, in plain words.
      required:
        - ok
        - error
        - message
      additionalProperties: true
  responses:
    Problem:
      description: >-
        Refused. 400 for a bad body, 401 for no key, 403 for a key or token that
        may not, 404 for an unknown route or id, 409 for a state that does not
        allow it, 413 for a body over 256 KB, 429 for too soon, 503 and 504 when
        no page answers.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    relayKey:
      type: http
      scheme: bearer
      description: 'The relay key, RELAY_KEY: Authorization: Bearer <key>.'
    relayKeyQuery:
      type: apiKey
      in: query
      name: key
      description: The relay key in the address, as the page sends it.
    sessionToken:
      type: http
      scheme: bearer
      description: >-
        A session's own token, OFFICE_TICKET_TOKEN. It reaches only the routes
        its role needs: see docs/manual/relay.html#tokens.

````

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