---
title: "POST AI Generate document"
method: POST
path: "/api/files/ai/generate-doc"
---

# POST AI Generate document

`POST /api/files/ai/generate-doc`

## Request

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

Cria um **novo documento Word (DOCX)** na sua empresa com o conteúdo redigido pelo Astro a partir de `title` e `description`.

*   `is_template` define se o documento é criado como template (`yes`) ou documento comum (`no`).
*   `folder_id` é opcional; sem ele o documento fica na raiz.
*   A criação é registrada no histórico do documento. A resposta é o documento criado no mesmo formato de `POST /api/files/upload` (`data`); `is_template` vem como enviado (`yes`/`no`).

## Request body

- object
  - `provider` 'openai', required: Provedor de IA. Único valor aceito: openai.
  - `model` 'gpt-4o-mini', required: Modelo. Único valor aceito: gpt-4o-mini.
  - `title` string, required: Título do documento (também usado como nome na plataforma).
  - `description` string, required: Descrição do que o documento deve conter.
  - `is_template` 'yes' | 'no', required: yes cria como template; no cria como documento comum.
  - `folder_id` integer: Id de uma pasta da sua empresa. Padrão: raiz.

## Response `200`

Documento criado

- object
  - `data` object: Documento criado, no mesmo formato de POST /api/files/upload.
    - `id` integer
    - `name` string
    - `file_name` string
    - `extension` string: Sempre docx.
    - `size` integer
    - `status` string
    - `document_key` string
    - `editted` string
    - `is_template` string: yes ou no, como enviado.
    - `template_fields` string
    - `accessibility` string
    - `departments` string
    - `folder` string: "Source" na raiz; objeto da pasta quando está em uma pasta.
    - `uploaded_by` object
      - `name` string
      - `last_name` string
    - `uploaded_on` string
    - `download` string
    - `tags` object[]
    - `editablevalidate` integer

## Other responses

- `403`: IA não habilitada para o usuário do token
- `422`: Erro de validação
- `500`: Falha ao gerar o documento com o assistente

## Changes

- **2026-11-03** `3db1513040ea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/plugsign/apis/endpoints-manuais/changes/api/files/ai/generate-doc/post.md)

---

[API](https://skmtc.dev/plugsign/apis/endpoints-manuais.md) - [All operations](https://skmtc.dev/plugsign/apis/endpoints-manuais/llms.txt) - [OpenAPI document](https://skmtc.dev/plugsign/apis/endpoints-manuais/revisions/3db1513040ea?raw)