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

# Obtenir les informations d'intégration d'un outil

> Récupère les détails nécessaires pour intégrer l'interface utilisateur d'un outil, y compris son schéma et les domaines autorisés. Accepte optionnellement 'external_user_id' pour limiter la portée du jeton d'accès retourné.



## OpenAPI

````yaml /api-reference/openapi.fr.json get /tools/{tool_id}/embed-info
openapi: 3.1.0
info:
  title: UBIK Public API
  description: Publicly accessible API endpoints for UBIK.
  version: '1.0'
servers:
  - url: https://app.ubik-agent.com/api/v1
    description: Production Server
security: []
paths:
  /tools/{tool_id}/embed-info:
    get:
      tags:
        - Public API
        - Public API - Tools
      summary: Obtenir les informations d'intégration d'un outil
      description: >-
        Récupère les détails nécessaires pour intégrer l'interface utilisateur
        d'un outil, y compris son schéma et les domaines autorisés. Accepte
        optionnellement 'external_user_id' pour limiter la portée du jeton
        d'accès retourné.
      operationId: get_public_tool_embed_info_tools__tool_id__embed_info_get
      parameters:
        - name: tool_id
          in: path
          required: true
          schema:
            type: string
            description: The unique identifier or name of the tool.
            title: Tool Id
          description: L'identifiant unique ou le nom de l'outil.
        - name: external_user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Optional external user ID to scope the access token.
            title: External User Id
          description: >-
            ID utilisateur externe optionnel pour limiter la portée du jeton
            d'accès.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicToolEmbedInfo'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    PublicToolEmbedInfo:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: L'identifiant unique de l'outil.
        name:
          type: string
          title: Name
          description: Le nom de l'outil.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Une brève description de ce que fait l'outil.
        input_schema:
          $ref: '#/components/schemas/ToolInputSchema'
          description: Le schéma JSON définissant les entrées pour l'outil.
        media_output_keys:
          items:
            type: string
          type: array
          title: Media Output Keys
          description: Une liste de clés dans la sortie qui contiennent des URL de médias.
        example_responses:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Example Responses
          description: >-
            Une liste d'exemples d'entrées et de leurs sorties correspondantes
            pour l'outil.
        allowed_origins:
          items:
            type: string
          type: array
          title: Allowed Origins
          description: Une liste de domaines autorisés pour l'intégration de cet outil.
        access_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Token
          description: >-
            Un jeton d'accès JWT de courte durée pour authentifier les appels
            API depuis l'interface utilisateur intégrée.
      type: object
      required:
        - id
        - name
        - input_schema
        - media_output_keys
        - example_responses
        - allowed_origins
      title: PublicToolEmbedInfo
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ToolInputSchema:
      properties:
        type:
          title: Type
          default: object
        properties:
          additionalProperties:
            $ref: '#/components/schemas/ToolPropertySchema'
          type: object
          title: Properties
          description: Un objet définissant les propriétés de l'objet d'entrée.
        required:
          items:
            type: string
          type: array
          title: Required
          description: Une liste des noms de propriétés qui sont requis.
        additionalProperties:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Additionalproperties
          default: false
        $defs:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/ToolPropertySchema'
              type: object
            - type: 'null'
          title: $Defs
      type: object
      title: ToolInputSchema
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ToolPropertySchema:
      properties:
        $ref: c6fc8fbd-c06f-4bd0-a063-ceb046296093
        type:
          anyOf:
            - {}
            - type: 'null'
          title: Type
          description: Le type de données de la propriété (par ex., 'string', 'integer').
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Une description de ce que représente la propriété.
        enum:
          anyOf:
            - items:
                anyOf:
                  - type: string
                  - type: integer
                  - type: number
                  - type: 'null'
              type: array
            - type: 'null'
          title: Enum
          description: Une liste de valeurs possibles si la propriété est une énumération.
        properties:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/ToolPropertySchema'
              type: object
            - type: 'null'
          title: Properties
        items:
          anyOf:
            - $ref: '#/components/schemas/ToolPropertySchema'
            - items:
                $ref: '#/components/schemas/ToolPropertySchema'
              type: array
            - type: 'null'
          title: Items
        required:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Required
        additionalProperties:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Additionalproperties
        default:
          anyOf:
            - {}
            - type: 'null'
          title: Default
        format:
          anyOf:
            - type: string
            - type: 'null'
          title: Format
      type: object
      title: ToolPropertySchema
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````