---
title: "POST File Optimize"
method: POST
path: "/api/files/optimize"
---

# POST File Optimize

`POST /api/files/optimize`

## Request

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

Otimiza um documento **PDF** (converte para uma versão compatível com a assinatura via API). Use quando `POST /api/files/sign` responder que o PDF usa compressão avançada (xref stream).

**Atenção:** a otimização descarta assinaturas e certificados já embutidos no documento. A operação fica registrada no histórico do documento.

## Request body

- object
  - `document_key` string, required: Document key do documento PDF a otimizar (precisa pertencer à sua empresa).

## Response `200`

200

- object
  - `message` string, required: PDF otimizado com sucesso.
  - `document_key` string: Document key do documento otimizado.
  - `pdf_optimization` object: Resultado da otimização.
    - `success` boolean
    - `status` string: completed ou failed.
    - `code` string: Código do resultado (ex.: PDF_OPTIMIZED).
    - `message` string
    - `stage` string
    - `retryable` boolean
    - `version_before` string
    - `version_after` string
    - `size_before` integer
    - `size_after` integer
    - `reduction_percent` number
    - `duration_ms` integer

## Other responses

- `404`: Documento de outra empresa
- `422`: document_key inexistente ou documento que não é PDF
- `503`: Falha na otimização (o status HTTP segue pdf_optimization; 503 quando o processador de PDF não está disponível)

## Changes

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

[Operation history](https://skmtc.dev/plugsign/apis/endpoints-manuais/changes/api/files/optimize/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)