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

# Conversar com agente

> Permite conversar com o agente via API enviando texto, imagem ou áudio



## OpenAPI

````yaml POST /v2/agent/{agentId}/conversation
openapi: 3.0.1
info:
  title: OpenAPI GPT Maker
  description: Documentação completa da API do GPT Maker
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.gptmaker.ai
security:
  - bearerAuth: []
paths:
  /v2/agent/{agentId}/conversation:
    post:
      description: Permite conversar com o agente via API enviando texto, imagem ou áudio
      parameters:
        - name: agentId
          in: path
          description: ID do agente
          required: true
          schema:
            type: string
      requestBody:
        description: Dados para conversar com o agente
        content:
          application/json:
            schema:
              oneOf:
                - title: Texto
                  type: object
                  properties:
                    contextId:
                      type: string
                      description: ID externo para identificar o cliente
                      example: '12345'
                    prompt:
                      type: string
                      description: Texto para o agente responder
                      example: oi qual seu nome?
                    callbackUrl:
                      type: string
                      description: >-
                        Caso seja informado, a chamada será assíncrona, quando o
                        agente responder, ele vai chamar esse webhook com a
                        resposta.
                      example: https://webhook.site
                    onFinishCallback:
                      type: string
                      description: >-
                        Caso seja informado, será disparado um webhook sempre
                        que o atendimento for finalizado.
                      example: https://webhook.site
                    chatName:
                      type: string
                      description: Você pode informar o nome do cliente caso já possua.
                      example: Fulano
                    chatPicture:
                      type: string
                      description: >-
                        Uma foto do cliente que será mostrada no chat de
                        atendimento.
                      example: https://foto.jpeg
                    phone:
                      type: string
                      description: Número de whatsapp do cliente.
                      example: 55xxxxxxxx
                  required:
                    - contextId
                    - prompt
                - title: Imagem
                  type: object
                  properties:
                    contextId:
                      type: string
                      description: ID externo para identificar o cliente
                      example: '12345'
                    prompt:
                      type: string
                      description: Texto para o agente responder
                      example: oq vc ve nessa imagem?
                    image:
                      type: string
                      description: URL da imagem
                      example: https://example.com/image.png
                    callbackUrl:
                      type: string
                      description: >-
                        Caso seja informado, a chamada será assíncrona, quando o
                        agente responder, ele vai chamar esse webhook com a
                        resposta.
                      example: https://webhook.site
                    onFinishCallback:
                      type: string
                      description: >-
                        Caso seja informado, será disparado um webhook sempre
                        que o atendimento for finalizado.
                      example: https://webhook.site
                    chatName:
                      type: string
                      description: Você pode informar o nome do cliente caso já possua.
                      example: Fulano
                    chatPicture:
                      type: string
                      description: >-
                        Uma foto do cliente que será mostrada no chat de
                        atendimento.
                      example: https://foto.jpeg
                    phone:
                      type: string
                      description: Número de whatsapp do cliente.
                      example: 55xxxxxxxx
                  required:
                    - contextId
                    - prompt
                    - image
                - title: Áudio
                  type: object
                  properties:
                    contextId:
                      type: string
                      description: ID externo para identificar o cliente
                      example: '12345'
                    audio:
                      type: string
                      description: URL do áudio
                      example: https://example.com/audio.mp3
                    callbackUrl:
                      type: string
                      description: >-
                        Caso seja informado, a chamada será assíncrona, quando o
                        agente responder, ele vai chamar esse webhook com a
                        resposta.
                      example: https://webhook.site
                    onFinishCallback:
                      type: string
                      description: >-
                        Caso seja informado, será disparado um webhook sempre
                        que o atendimento for finalizado.
                      example: https://webhook.site
                    chatName:
                      type: string
                      description: Você pode informar o nome do cliente caso já possua.
                      example: Fulano
                    chatPicture:
                      type: string
                      description: >-
                        Uma foto do cliente que será mostrada no chat de
                        atendimento.
                      example: https://foto.jpeg
                    phone:
                      type: string
                      description: Número de whatsapp do cliente.
                      example: 55xxxxxxxx
                  required:
                    - contextId
                    - audio
                - title: Vídeo
                  type: object
                  properties:
                    contextId:
                      type: string
                      description: ID externo para identificar o cliente
                      example: '12345'
                    video:
                      type: string
                      description: URL do vídeo
                      example: https://example.com/video.mp4
                    prompt:
                      type: string
                      description: Texto para o agente responder/caption do vídeo
                      example: o que você acha desse vídeo?
                    callbackUrl:
                      type: string
                      description: >-
                        Caso seja informado, a chamada será assíncrona, quando o
                        agente responder, ele vai chamar esse webhook com a
                        resposta.
                      example: https://webhook.site
                    onFinishCallback:
                      type: string
                      description: >-
                        Caso seja informado, será disparado um webhook sempre
                        que o atendimento for finalizado.
                      example: https://webhook.site
                    chatName:
                      type: string
                      description: Você pode informar o nome do cliente caso já possua.
                      example: Fulano
                    chatPicture:
                      type: string
                      description: >-
                        Uma foto do cliente que será mostrada no chat de
                        atendimento.
                      example: https://foto.jpeg
                    phone:
                      type: string
                      description: Número de whatsapp do cliente.
                      example: 55xxxxxxxx
                  required:
                    - contextId
                    - video
                - title: Documento
                  type: object
                  properties:
                    contextId:
                      type: string
                      description: ID externo para identificar o cliente
                      example: '12345'
                    document:
                      type: string
                      description: URL do documento a ser enviado
                      example: https://example.com/document.pdf
                    prompt:
                      type: string
                      description: Texto para o agente responder/caption do documento
                      example: o que você acha desse documento?
                    callbackUrl:
                      type: string
                      description: >-
                        Caso seja informado, a chamada será assíncrona, quando o
                        agente responder, ele vai chamar esse webhook com a
                        resposta.
                      example: https://webhook.site
                    onFinishCallback:
                      type: string
                      description: >-
                        Caso seja informado, será disparado um webhook sempre
                        que o atendimento for finalizado.
                      example: https://webhook.site
                    chatName:
                      type: string
                      description: Você pode informar o nome do cliente caso já possua.
                      example: Fulano
                    chatPicture:
                      type: string
                      description: >-
                        Uma foto do cliente que será mostrada no chat de
                        atendimento.
                      example: https://foto.jpeg
                    phone:
                      type: string
                      description: Número de whatsapp do cliente.
                      example: 55xxxxxxxx
                  required:
                    - contextId
                    - document
        required: true
      responses:
        '200':
          description: Resposta do agente
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Resposta do agente
                  images:
                    type: array
                    items:
                      type: string
                      description: URLs das imagens respondidas pelo agente
                  audios:
                    type: array
                    items:
                      type: string
                      description: URLs dos áudios respondidos pelo agente
                  documents:
                    type: array
                    items:
                      type: string
                      description: URLs dos documentos respondidos pelo agente
        '400':
          description: Erro inesperado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Erro de token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
components:
  schemas:
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    Error403:
      required:
        - error
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````