POST AI Generate summary

Changed on

Gera um resumo do documento com o Astro e o salva no documento.

  • Com audio: false, a resposta traz o resumo em message (HTML simples).
  • Com audio: true, a API também converte o resumo em áudio (MP3) e responde com audio (URL de POST /api/files/ai/audio/{document_key} para baixá-lo). Nesse caso message traz o resultado da geração do áudio (true/false), não o texto; o resumo fica salvo no documento.
  • Se não for possível extrair o texto do documento, message vem como false.
post/api/files/ai/generate-summary

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/files/ai/generate-summary
  • Auth
    API key in header Authorization

Request body

provider'openai' required

Provedor de IA. Único valor aceito: openai.

model'gpt-4o-mini' required

Modelo. Único valor aceito: gpt-4o-mini.

document_keystring required

Document Key de um documento da sua empresa.

audioboolean required

true para também gerar o áudio (MP3) do resumo.

Response

Resumo gerado

messagestring

Resumo em HTML simples (audio: false) ou resultado true/false da geração do áudio (audio: true).

audiostring

URL para baixar o MP3 (apenas com audio: true).

Changes