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

# Prepare an expiring owner-signed Telegram request

> Optional runtime, disabled unless durable storage and an external encryption key are configured. An owner signature is mandatory for all configuration access and mutation. Chat delivery requires private-chat start proof followed by owner-signed confirmation.



## OpenAPI

````yaml /openapi/platform.json post /v1/yield/telegram/challenge
openapi: 3.1.0
info:
  title: GOL Platform API
  description: >-
    Versioned GOL developer and consumer API. Consumer routes are mounted when
    their runtime integrations are configured.
  version: 0.8.0-rc.1
servers:
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: system
  - name: authentication
  - name: projects
  - name: api-keys
  - name: audit
  - name: gas-executions
  - name: gas-policies
  - name: webhooks
paths:
  /v1/yield/telegram/challenge:
    post:
      tags:
        - Telegram
      summary: Prepare an expiring owner-signed Telegram request
      description: >-
        Optional runtime, disabled unless durable storage and an external
        encryption key are configured. An owner signature is mandatory for all
        configuration access and mutation. Chat delivery requires private-chat
        start proof followed by owner-signed confirmation.
      operationId: prepareTelegramChallenge
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TelegramChallengeInput'
      responses:
        '201':
          description: Telegram request result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelegramChallenge'
        '400':
          description: Invalid request
        '403':
          description: Owner, scope, signature, chat proof or challenge does not match
        '503':
          description: Telegram runtime, owner reader or bot adapter unavailable
components:
  schemas:
    TelegramChallengeInput:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - chainId
            - account
            - profileId
            - vault
            - owner
            - action
            - botToken
            - enabled
          properties:
            chainId:
              type: string
              enum:
                - '8453'
                - '84532'
            account:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            profileId:
              pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            vault:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            owner:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            action:
              type: string
              enum:
                - configure
            botToken:
              type: string
              writeOnly: true
              pattern: ^[0-9]{5,20}:[A-Za-z0-9_-]{20,100}$
            enabled:
              type: boolean
        - type: object
          additionalProperties: false
          required:
            - chainId
            - account
            - profileId
            - vault
            - owner
            - action
            - chatId
          properties:
            chainId:
              type: string
              enum:
                - '8453'
                - '84532'
            account:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            profileId:
              pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            vault:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            owner:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            action:
              type: string
              enum:
                - confirm
            chatId:
              type: string
              pattern: ^[1-9][0-9]{0,15}$
        - type: object
          additionalProperties: false
          required:
            - chainId
            - account
            - profileId
            - vault
            - owner
            - action
            - enabled
          properties:
            chainId:
              type: string
              enum:
                - '8453'
                - '84532'
            account:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            profileId:
              pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            vault:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            owner:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            action:
              type: string
              enum:
                - preferences
            enabled:
              type: boolean
        - type: object
          additionalProperties: false
          required:
            - chainId
            - account
            - profileId
            - vault
            - owner
            - action
          properties:
            chainId:
              type: string
              enum:
                - '8453'
                - '84532'
            account:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            profileId:
              pattern: ^0x[0-9a-fA-F]{64}$
              type: string
            vault:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            owner:
              pattern: ^0x[0-9a-fA-F]{40}$
              type: string
            action:
              type: string
              enum:
                - status
                - disconnect
    TelegramChallenge:
      type: object
      additionalProperties: false
      required:
        - challengeId
        - message
        - expiresAt
      properties:
        challengeId:
          format: uuid
          type: string
        message:
          type: string
        expiresAt:
          format: date-time
          type: string

````

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