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

# Look message

> Roda um modelo de visão sobre o anexo (`messageKey: 'file'` ou `'image'`)
de uma mensagem e grava a descrição em `messageValue.looker`.

Se a mensagem já possui `messageValue.looker`, o endpoint devolve a
mensagem imediatamente, sem rodar o modelo novamente.

Anexos em PDF são primeiro convertidos para JPEG e o resultado é
publicado no storage antes da análise.



## OpenAPI

````yaml /api/services-api.yaml put /v1/tenants/{tenantID}/messages/{messageID}/look
openapi: 3.0.3
info:
  description: >-
    Talqui is an omnichannel customer service platform that unifies
    conversations from WhatsApp, Instagram, Telegram, and many other channels
    into a single attendant panel, alongside a broader ecosystem of plugins and
    integrations. This API gives developers programmatic access to Talqui's
    services layer, exposing the operations needed to read and manage tenants,
    conversations, plugins, and related resources that power that platform.


    Authentication is available on behalf of an Operator (the default for this
    API), a Plugin Connection, or a Plugin — see the [Talqui authentication
    guide](https://docs.talqui.chat/guides/introduction/authentication/) for how
    each token is obtained and when to use it.


    Need help or have questions not covered here? Reach out to
    support@talqui.com.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui - Services API
  version: 0.65.0
servers:
  - description: Production
    url: https://services-api.talqui.chat
security: []
tags:
  - name: Tenants
  - name: Settings
  - name: Analytics
  - name: Campaigns
  - name: Campaigns models
  - name: Contacts
  - name: Handoff links
  - name: Inboxes
  - name: Messages
  - name: Notifications
  - name: Sessions
  - name: Operators
  - name: Plugins
  - name: Setup
  - name: Uploads
paths:
  /v1/tenants/{tenantID}/messages/{messageID}/look:
    put:
      tags:
        - Messages
      summary: Look message
      description: >-
        Roda um modelo de visão sobre o anexo (`messageKey: 'file'` ou
        `'image'`)

        de uma mensagem e grava a descrição em `messageValue.looker`.


        Se a mensagem já possui `messageValue.looker`, o endpoint devolve a

        mensagem imediatamente, sem rodar o modelo novamente.


        Anexos em PDF são primeiro convertidos para JPEG e o resultado é

        publicado no storage antes da análise.
      operationId: LookMessageController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            description: The tenant the message belongs to.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
        - in: path
          name: messageID
          required: true
          schema:
            description: The message (attachment) to analyze.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  message:
                    additionalProperties: false
                    description: The message with messageValue.looker filled in.
                    properties:
                      campaignModelID:
                        description: >-
                          The campaign model this message originated from, if
                          any.
                        nullable: true
                        type: string
                      contactID:
                        description: The contact this message belongs to.
                        type: string
                      createdAt:
                        description: When this message was created.
                        format: date-time
                        type: string
                      messageAutonomous:
                        description: >-
                          Whether this message was sent autonomously (by a
                          bot/automation).
                        type: boolean
                      messageChannel:
                        description: The channel this message was sent through.
                        type: string
                      messageDirection:
                        description: Whether this message is inbound or outbound.
                        type: string
                      messageExternalID:
                        description: Provider-side identifier for this message, if any.
                        type: string
                      messageFingerprint:
                        description: Deduplication fingerprint for this message.
                        type: string
                      messageID:
                        description: Unique identifier for this message.
                        type: string
                      messageKey:
                        description: >-
                          The message content type; `file` or `image` for the
                          looker endpoint.
                        type: string
                      messageMeta:
                        additionalProperties: {}
                        description: Arbitrary metadata attached to the message.
                        type: object
                      messageStatus:
                        description: Numeric status code for this message.
                        type: number
                      messageValue:
                        additionalProperties: {}
                        description: Message content, including `looker` once analyzed.
                        type: object
                      operatorID:
                        description: The operator who sent this message, if any.
                        nullable: true
                        type: string
                      sessionID:
                        description: The session this message belongs to.
                        type: string
                      tenantID:
                        description: The tenant this message belongs to.
                        type: string
                      updatedAt:
                        description: When this message was last updated.
                        format: date-time
                        type: string
                    required:
                      - messageID
                      - tenantID
                      - contactID
                      - sessionID
                      - operatorID
                      - campaignModelID
                      - messageAutonomous
                      - messageChannel
                      - messageDirection
                      - messageKey
                      - messageValue
                      - messageMeta
                      - messageStatus
                      - messageFingerprint
                      - createdAt
                      - updatedAt
                    type: object
                required:
                  - message
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/MissingTenantIDError'
                        - $ref: '#/components/schemas/MissingMessageIDError'
                        - $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL. | MissingMessageIDError (error_code 1069): messageID absent
            from the URL. | RequestValidationError (error_code 1002): params
            fail UUID format validation.
        '401':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnauthorizedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.'
        '403':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/ForbiddenError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'ForbiddenError (error_code 1004): operator token rejected upstream.'
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/MessageNotFoundError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MessageNotFoundError (error_code 1068): messageID does not exist for
            this tenant (or is not a 'file'/'image' message).
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
        '502':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/PdfConversionError'
                        - $ref: '#/components/schemas/MessageLookFailedError'
                        - $ref: '#/components/schemas/StorageUploadError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            PdfConversionError (error_code 5012): the PDF attachment could not
            be converted to an image. | MessageLookFailedError (error_code
            5013): the vision model produced no usable description. |
            StorageUploadError (error_code 5008): the converted PDF image could
            not be written to storage.
      security:
        - operatorAuth: []
components:
  schemas:
    MissingTenantIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingTenantIDError
          type: string
        error_code:
          enum:
            - 1001
          type: number
        message:
          example: tenantID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    MissingMessageIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingMessageIDError
          type: string
        error_code:
          enum:
            - 1069
          type: number
        message:
          example: messageID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    RequestValidationError:
      additionalProperties: false
      properties:
        error:
          enum:
            - RequestValidationError
          type: string
        error_code:
          enum:
            - 1002
          type: number
        fields:
          items:
            additionalProperties: false
            properties:
              allowed:
                type: string
              field:
                type: string
              received:
                type: string
            required:
              - field
              - received
              - allowed
            type: object
          type: array
        message:
          example: Invalid request data.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
        - fields
      type: object
    UnauthorizedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnauthorizedError
          type: string
        error_code:
          enum:
            - 1003
          type: number
        message:
          example: You are not authorized to perform this request.
          type: string
        statusCode:
          enum:
            - 401
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    ForbiddenError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ForbiddenError
          type: string
        error_code:
          enum:
            - 1004
          type: number
        message:
          example: You do not have access to this resource.
          type: string
        statusCode:
          enum:
            - 403
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    MessageNotFoundError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MessageNotFoundError
          type: string
        error_code:
          enum:
            - 1068
          type: number
        message:
          example: Message not found.
          type: string
        statusCode:
          enum:
            - 404
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    PdfConversionError:
      additionalProperties: false
      properties:
        error:
          enum:
            - PdfConversionError
          type: string
        error_code:
          enum:
            - 5012
          type: number
        message:
          example: Failed to convert PDF to image.
          type: string
        statusCode:
          enum:
            - 502
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    MessageLookFailedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MessageLookFailedError
          type: string
        error_code:
          enum:
            - 5013
          type: number
        message:
          example: Failed to analyze the message image.
          type: string
        statusCode:
          enum:
            - 502
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    StorageUploadError:
      additionalProperties: false
      properties:
        error:
          enum:
            - StorageUploadError
          type: string
        error_code:
          enum:
            - 5008
          type: number
        message:
          example: Failed to upload file to storage.
          type: string
        statusCode:
          enum:
            - 502
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
  securitySchemes:
    operatorAuth:
      bearerFormat: JWT
      description: >-
        Behalf of an Operator (default). A JWT issued by Talqui Core when an
        operator signs in, scoped to every tenant that operator belongs to. Send
        as `Authorization: Bearer <jwt-token>`.
      scheme: bearer
      type: http

````

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