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

# Get Bot Definition

> ワークスペースのAI Bot設定（名前・文字起こし辞書・入室メッセージ）を取得します。
読み取り専用です。
未設定のワークスペースでは 404 を返します。
APIキーが代表するワークスペースの設定のみ取得でき、他ワークスペースには越境できません。
本エンドポイントは query parameter を受け付けません。指定した場合は 400 を返します。




## OpenAPI

````yaml /openapi.yaml get /v1/bot-definition
openapi: 3.1.0
info:
  title: Frictio Public API
  version: 1.0.0-beta
servers:
  - url: https://public-api.frictio.ai
security:
  - ApiKeyAuth: []
paths:
  /v1/bot-definition:
    get:
      summary: Get Bot Definition
      description: |
        ワークスペースのAI Bot設定（名前・文字起こし辞書・入室メッセージ）を取得します。
        読み取り専用です。
        未設定のワークスペースでは 404 を返します。
        APIキーが代表するワークスペースの設定のみ取得でき、他ワークスペースには越境できません。
        本エンドポイントは query parameter を受け付けません。指定した場合は 400 を返します。
      operationId: getBotDefinition
      parameters:
        - $ref: '#/components/parameters/workspaceId'
      responses:
        '200':
          description: 成功
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/BotDefinition'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    workspaceId:
      name: X-Workspace-Id
      in: header
      required: true
      description: ワークスペースID
      schema:
        type: string
      example: e1f2a3b4-...
  schemas:
    BotDefinition:
      type: object
      description: |
        ワークスペースのAI Bot設定。
        内部IDは公開しません。
      required:
        - name
        - transcription_hints
      properties:
        name:
          type: string
          description: AI Botの表示名
          example: Frictio Bot
        transcription_hints:
          type: array
          description: 文字起こし辞書（AI 辞書）
          items:
            $ref: '#/components/schemas/BotTranscriptionHint'
        message_on_join:
          $ref: '#/components/schemas/BotMessageOnJoin'
    BotTranscriptionHint:
      type: object
      description: 文字起こしヒントの1要素
      required:
        - hint
      properties:
        hint:
          type: string
          description: 辞書に登録する語
          example: Frictio
        intensity:
          type: number
          description: ヒント強度（任意）
          example: 0.3
        language:
          type: string
          description: 言語コード（任意）
          example: ja
        pronunciations:
          type: array
          description: 読み・発音の候補（任意）
          items:
            type: string
          example:
            - フリクシオ
        replacements:
          type: array
          description: 置換候補（任意）
          items:
            type: string
    BotMessageOnJoin:
      type: object
      description: 入室時メッセージ設定
      required:
        - active
        - frequency
        - message
      properties:
        active:
          type: boolean
          description: 入室メッセージが有効か
          example: true
        frequency:
          type: string
          description: 送信頻度
          enum:
            - ON_BOT_JOIN
            - ON_PARTICIPANT_JOIN
          example: ON_BOT_JOIN
        message:
          type: string
          description: 入室時に送信するメッセージ本文
          example: 応対品質向上を目的として本ミーティングの録画・文字起こしをしております。気になる場合は当社ミーティング担当者にお申し付けください。
    Error:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTPステータスコード
          example: 404
        message:
          type: string
          description: エラーメッセージ
          example: Meeting not found
        error:
          type: string
          description: |
            エラー種別。メッセージ文字列付きで例外が生成された場合のみ含まれます。
          example: Not Found
  responses:
    BadRequest:
      description: クエリパラメータまたはIDの形式が不正です
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 400
            message: Bad Request
            error: Bad Request
    Unauthorized:
      description: APIキーが無効、失効、期限切れ、または未指定です
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            invalidApiKey:
              summary: 無効な API キー
              value:
                statusCode: 401
                message: Invalid API key
                error: Unauthorized
            missingApiKey:
              summary: API キー未指定
              value:
                statusCode: 401
                message: Missing X-Api-Key header
                error: Unauthorized
    Forbidden:
      description: 権限エラー
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            message: Forbidden
    NotFound:
      description: リソースが見つかりません
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 404
            message: Not Found
    TooManyRequests:
      description: レートリミット超過
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 429
            message: Too Many Requests
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````

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