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

# Start Telegram Link

> A deep link that offers the caller's account to whoever opens it in Telegram.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/me/external-identities/telegram/link
openapi: 3.1.0
info:
  description: >-
    Modular and extensible framework for building AI agents. This API requires
    JWT Bearer token authentication for most endpoints. Include your JWT token
    in the Authorization header. Public endpoints include /, /health, /docs,
    /redoc, and /openapi.json.
  title: AgentArea API
  version: 0.1.0
servers: []
security:
  - bearer: []
paths:
  /v1/me/external-identities/telegram/link:
    post:
      tags:
        - v1
        - protected
        - external-identities
      summary: Start Telegram Link
      description: >-
        A deep link that offers the caller's account to whoever opens it in
        Telegram.
      operationId: start_telegram_link_v1_me_external_identities_telegram_link_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TelegramLinkRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelegramLinkResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    TelegramLinkRequest:
      properties:
        bot:
          description: The bot to open the link in
          pattern: ^[A-Za-z0-9_]{5,32}$
          title: Bot
          type: string
      required:
        - bot
      title: TelegramLinkRequest
      type: object
    TelegramLinkResponse:
      properties:
        expires_in:
          title: Expires In
          type: integer
        url:
          title: Url
          type: string
      required:
        - url
        - expires_in
      title: TelegramLinkResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: JWT Bearer token for authentication
      scheme: bearer
      type: http
    HTTPBearer:
      scheme: bearer
      type: http

````

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