Documentação da API
Referência completa da API REST do mecanismo auto-hospedado do promptShield. Todos os endpoints estão disponíveis na URL da sua implantação.
URL base
http://localhost:8000Substitua pelo host e pela porta da sua implantação.
Esquema OpenAPI
O servidor disponibiliza /docs (Swagger UI), /redoc e /openapi.json. No modo de chave de API, os três exigem o cabeçalho Authorization, por isso um navegador não consegue abri-los diretamente. Obtenha o esquema e carregue em qualquer cliente capaz de enviar um cabeçalho:
curl -H "Authorization: Bearer $PROMPTSHIELD_API_KEY" \
http://localhost:8000/openapi.json -o promptshield-openapi.jsonUm navegador não consegue enviar o cabeçalho Authorization em uma navegação, por isso /docs responde 401 no modo de chave de API. O esquema acima é o caminho que funciona.
Autenticação
Quando PROMPTSHIELD_API_KEY está definida (por promptshield serve --api-key ou pela variável de ambiente do Docker), cada requisição precisa enviá-la como Authorization: Bearer <api-key>; chaves ausentes ou erradas recebem 401, e uma chave com escopo limitado a algumas operações recebe 403 nas demais. O endpoint /health está sempre isento. Se nenhuma chave de API estiver definida, o servidor roda sem autenticação e aceita todas as requisições, o que só é adequado em uma rede local de confiança.
Início rápido
Coloque a API local para rodar com o Docker. O primeiro download ocupa cerca de 3,8 GB.
Obter sua chave de API
export PROMPTSHIELD_API_KEY="ps_live_your_key_here"Sua chave de API está disponível no painel de chaves de API.
Iniciar o servidor
docker run -d --name promptshield \
-e PROMPTSHIELD_API_KEY="$PROMPTSHIELD_API_KEY" \
-p 8000:8000 \
-v promptshield-data:/data \
promptshield/promptshield-api:latestA imagem inclui o Tesseract OCR, o LibreOffice e os modelos de detecção de inglês e francês. Os outros idiomas são instalados com promptshield models install.
Confirmar que está funcionando
curl http://localhost:8000/health
# → {"status": "ok", "version": "1.3.6"}Processar seu primeiro documento
AUTH="Authorization: Bearer ps_live_your_key_here"
curl -X POST http://localhost:8000/api/documents/upload \
-H "$AUTH" \
-F "file=@contract.pdf"
# → {"doc_id": "abc123", "filename": "contract.pdf", "page_count": 5, "status": "EXTRACTED"}
curl -X POST http://localhost:8000/api/documents/abc123/detect \
-H "$AUTH" \
-H "Content-Type: application/json" \
-d '{"confidence_threshold": 0.7}'
# → {"doc_id": "abc123", "total_regions": 42, "regions": [...]}
curl -X POST http://localhost:8000/api/documents/abc123/anonymize \
-H "$AUTH"
# → {"doc_id": "abc123", "tokens_created": 42, "regions_removed": 0, "output_path": "..."}
curl -o contract-safe.pdf \
-H "$AUTH" \
http://localhost:8000/api/documents/abc123/download/pdfPrefere uma instalação local em Python?
O pacote Python ainda não está no PyPI, por isso pip install promptshield-app não vai funcionar. Use a imagem Docker acima ou compile a partir do código-fonte. Vamos atualizar esta página quando o pacote for publicado.
Guia passo a passo
Um passo a passo completo para configurar a API local e integrá-la ao seu fluxo de trabalho.
1. Pré-requisitos
Antes de começar, verifique se você tem o seguinte instalado:
Opcional (para suporte completo a formatos):
2. Instalar o SDK
Instale o pacote Python do promptShield. A instalação base trata arquivos PDF. Adicione o extra office para Word/Excel/PowerPoint.
O pacote Python ainda não foi publicado no PyPI, por isso os dois comandos abaixo não vão funcionar. Por enquanto, use a imagem Docker da seção 5. Todo o resto desta página vale para as duas formas.
pip install promptshield-apppip install "promptshield-app[office]"Instale modelos de idioma (pacotes de entidades) pela CLI:
# Set the install directory (add to your shell profile)
export PROMPTSHIELD_ASSETS_DIR="$HOME/.local/share/promptshield/assets"
# Windows: $env:PROMPTSHIELD_ASSETS_DIR = "$env:APPDATA\promptshield\assets"
# English pack — required (medium is recommended)
promptshield models install spacy-en-md
# For maximum accuracy (larger download)
promptshield models install spacy-en-lgInstale pacotes de idioma adicionais da mesma forma:
promptshield models install spacy-fr-md # French
promptshield models install spacy-de-md # German
promptshield models install spacy-es-md # Spanish
promptshield models install spacy-it-md # Italian
promptshield models install spacy-nl-md # Dutch
promptshield models install spacy-pt-md # Portuguese3. Autenticação
A API local usa sua chave de API do promptShield para validar a licença. Defina a chave como variável de ambiente ou informe ao iniciar o servidor.
export PROMPTSHIELD_API_KEY="ps_live_your_key_here"$env:PROMPTSHIELD_API_KEY = "ps_live_your_key_here"A chave de API é validada online na inicialização e novamente a cada 6 horas. Cada resposta fica em cache localmente, e assim o servidor continua funcionando por até 3 dias se não conseguir contatar o servidor de licenças.
4. Iniciar o servidor da API
Inicie o servidor local com um único comando:
promptshield serve
# Starting PromptShield API server on 127.0.0.1:8000
# Health: http://127.0.0.1:8000/health (no auth)
# Schema: http://127.0.0.1:8000/openapi.json (send: Authorization: Bearer <your-api-key>)
# /docs and /redoc are served but require that same header, so a browser cannot open them directly.Opções disponíveis:
| --host | Endereço de escuta (padrão: 127.0.0.1) |
| --port | Porta de escuta (padrão: 8000) |
| --api-key | Chave de API (alternativa à variável de ambiente) |
Depois de iniciada, a API fica disponível na URL exibida. O esquema OpenAPI está em /openapi.json; envie sua chave de API também nessa requisição.
5. Implantação com Docker
Para implantações em produção, o Docker oferece uma experiência sem instalação, com todas as dependências incluídas.
docker run -d --name promptshield \
-e PROMPTSHIELD_API_KEY="ps_live_your_key_here" \
-p 8000:8000 \
-v promptshield-data:/data \
promptshield/promptshield-api:latest# docker-compose.yml
services:
promptshield:
image: promptshield/promptshield-api:latest
ports:
- "8000:8000"
volumes:
- promptshield-data:/data
environment:
- PROMPTSHIELD_API_KEY=${PROMPTSHIELD_API_KEY}
restart: unless-stopped
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
interval: 30s
volumes:
promptshield-data:Crie um arquivo .env com sua chave de API:
PROMPTSHIELD_API_KEY=ps_live_your_key_hereA imagem Docker inclui:
6. Fluxo de trabalho da API
O fluxo de trabalho padrão de processamento de documentos tem 5 passos:
Exemplo de fluxo de trabalho completo (cURL)
# 1. Upload
AUTH="Authorization: Bearer ps_live_your_key_here"
DOC_ID=$(curl -s -X POST http://localhost:8000/api/documents/upload \
-H "$AUTH" \
-F "file=@contract.pdf" | python -c "import sys,json; print(json.load(sys.stdin)['doc_id'])")
echo "Document ID: $DOC_ID"
# 2. Detect PII (with optional inline overrides)
curl -X POST http://localhost:8000/api/documents/$DOC_ID/detect \
-H "$AUTH" \
-H "Content-Type: application/json" \
-d '{"confidence_threshold": 0.7, "regex_enabled": true, "ner_enabled": true}'
# → {"doc_id": "...", "total_regions": 42, "regions": [...]}
# 3. Review detected regions
curl -H "$AUTH" http://localhost:8000/api/documents/$DOC_ID/regions | python -m json.tool
# → [{"id": "...", "pii_type": "PERSON", "text": "John Smith", "confidence": 0.98,
# "action": "TOKENIZE", ...}, ...]
# 3b. Bulk-update region actions before anonymizing (region_ids from step 3)
curl -X PUT http://localhost:8000/api/documents/$DOC_ID/regions/batch-action \
-H "$AUTH" \
-H "Content-Type: application/json" \
-d '{"region_ids": ["<id1>", "<id2>"], "action": "REMOVE"}'
# 4. Anonymize
curl -X POST http://localhost:8000/api/documents/$DOC_ID/anonymize \
-H "$AUTH"
# → {"doc_id": "...", "tokens_created": 42, "regions_removed": 0}
# 5. Download the anonymized document
curl -o contract-safe.pdf \
-H "$AUTH" \
http://localhost:8000/api/documents/$DOC_ID/download/pdf
echo "Done! Anonymized file saved to contract-safe.pdf"7. Comandos da CLI
Processe documentos direto na linha de comando, sem iniciar um servidor:
promptshield detect invoice.pdf
# Detected 23 PII entities across 5 pages
promptshield detect invoice.pdf -o report.json
# Report saved to report.json
# Tune the pipeline per run — every desktop-app setting is also a CLI flag.
promptshield detect contract.pdf \
--language en --countries US \
--ner-backend Davlan/bert-base-multilingual-cased-ner-hrl \
--no-llm --fuzziness 0.5 \
--ner-types PERSON,ORG \
-e SA-2026-0847 -e "84-329-1057" \
--export-review -o contract.psreview
# Or load all of the above from demo/setup.json by locale:
promptshield detect contract.pdf --preset en --export-review -o contract.psreviewpromptshield anonymize contract.pdf -o contract-safe.pdf
# Anonymized: 42 tokens created, saved to contract-safe.pdf
# Permanently redact PII (black boxes, irreversible)
promptshield anonymize contract.pdf --redact -o contract-redacted.pdfpromptshield detokenize contract-safe.pdf -o contract-restored.pdf
# Restored 42 tokens, saved to contract-restored.pdfTodos os comandos da CLI validam sua chave de API e processam os documentos localmente. Nenhum dado dos documentos sai do seu dispositivo.
Extras de modelos
Use o comando models integrado para procurar, instalar e remover pacotes de idioma de entidades. Defina PROMPTSHIELD_ASSETS_DIR para que a CLI e o servidor em execução os encontrem.
export PROMPTSHIELD_ASSETS_DIR="$HOME/.local/share/promptshield/assets"
# Windows: $env:PROMPTSHIELD_ASSETS_DIR = "$env:APPDATA\promptshield\assets"promptshield models list
# Language packs (NER)
# [ ] spacy-en-sm English (small) (12 MB)
# [installed] spacy-en-md English (medium) (33 MB)
# [ ] spacy-fr-md French (medium) (16 MB) ...promptshield models install spacy-fr-md
# Installing spacy-fr-md (French (medium))...
# Downloading... 16.0/16.0 MB (100%)
# Verifying integrity...
# Extracting...
# Installed to ~/.local/share/promptshield/assets/spacy/fr_core_news_mdpromptshield models installed
# Installed models:
# spacy-en-md English (medium)
# spacy-fr-md French (medium)promptshield models remove spacy-fr-mdOs pacotes instalados são reconhecidos automaticamente pelo detect, pelo anonymize e pelo servidor da API em execução. O comando install se comunica diretamente com o servidor de licenças: não é preciso nenhum sidecar em execução.
8. Expressões personalizadas
Os padrões e as entidades integrados cobrem a maioria dos dados pessoais, mas cada organização tem seus próprios identificadores: números de contrato, códigos internos de projeto, números fiscais, marcações de confidencialidade. Adicione esses identificadores como expressões e eles passam a ser tratados como dados pessoais plenos, sinalizados com o tipo CUSTOM, com caixa delimitadora completa + propagação entre páginas. Disponível na CLI (-e / --expression), na API HTTP auto-hospedada (blacklist_terms) e pelas predefinições de demo/setup.json.
# Literal text — case-insensitive substring match
promptshield detect contract.pdf -e SA-2026-0847 -e "84-329-1057"
# Repeatable — pass as many -e flags as you need
promptshield detect contract.pdf \
-e ACME-CONFIDENTIAL \
-e "Internal Use Only" \
-e CUST-12345
# Regex — prefix with "re:" for full regex semantics
promptshield detect contract.pdf \
-e "re:CASE-\d{4}-[A-Z]{3}" \
-e "re:Project [A-Z][a-z]+"# Same feature on the self-hosted HTTP API.
curl -X POST http://localhost:8000/api/documents/$DOC_ID/detect \
-H "$AUTH" \
-H "Content-Type: application/json" \
-d '{
"expressions": ["SA-2026-0847", "84-329-1057"],
"expressions_action": "tokenize",
"expressions_fuzziness": 1.0
}'
# expressions_action: "none" | "tokenize" | "remove"
# expressions_fuzziness: 1.0 = exact match, 0.5 = fuzzy edit-distance match
#
# Back-compat: the legacy keys "blacklist_terms" / "blacklist_action" /
# "blacklist_fuzziness" still work and map to the same fields via
# Pydantic alias — existing integrations don't need changes.# demo/setup.json
{
"en": {
"language": "en",
"countries": ["US"],
"ner_backend": "Davlan/bert-base-multilingual-cased-ner-hrl",
"expressions": ["SA-2026-0847", "84-329-1057"],
"fuzziness": 0.5
}
}
# Then any time:
promptshield detect contract.pdf --preset en --export-review -o contract.psreviewSobre o nome: expressions agora é o nome canônico nas três superfícies: CLI (-e / --expression), API HTTP (expressions / expressions_action / expressions_fuzziness) e o rótulo na interface do aplicativo para computador. As chaves anteriores blacklist_terms / blacklist_action / blacklist_fuzziness da API HTTP continuam funcionando por meio de um alias do Pydantic, para manter a retrocompatibilidade, de modo que as integrações existentes não quebram.
Fluxo de revisão: API → Aplicativo para computador
A detecção automática em escala é só metade da história: ela nunca atinge 100% de precisão, e sempre há falsos positivos para dispensar e entidades faltando para acrescentar. O promptShield fecha o ciclo com um pacote .psreview portátil: detecte de forma programática, importe no aplicativo para computador para um controle de qualidade visual feito por uma pessoa e depois anonimize.
Passo 1a: detectar e exportar (CLI, em um só comando)
# Detect + bundle in one command
promptshield detect contract.pdf --export-review -o contract.psreview
# Ingesting contract.pdf...
# Detecting PII on page 1/3...
# Detecting PII on page 2/3...
# Detecting PII on page 3/3...
# Detected 14 PII region(s) across 3 page(s) in 1240ms.
# Review bundle saved to contract.psreview (14 region(s))Passo 1b: detectar e exportar (API HTTP)
# 1. Upload document
curl -X POST http://localhost:8000/api/documents/upload \
-H "Authorization: Bearer $PROMPTSHIELD_API_KEY" \
-F "file=@contract.pdf"
# → {"doc_id": "abc123ef", "page_count": 3, ...}
# 2. Run detection
curl -X POST http://localhost:8000/api/documents/abc123ef/detect \
-H "Authorization: Bearer $PROMPTSHIELD_API_KEY"
# 3. Download the review bundle
curl http://localhost:8000/api/documents/abc123ef/export-review \
-H "Authorization: Bearer $PROMPTSHIELD_API_KEY" \
-o contract.psreview.psreview API
/api/documents/{id}/export-reviewExportar pacote de revisão
Baixa o documento e todas as anotações de regiões como um pacote .psreview (ZIP portátil).
/api/documents/import-reviewImportar pacote de revisão
Envie um pacote .psreview. Extrai o documento (executa OCR), injeta as anotações de regiões salvas e abre o documento no status REVIEWING, pronto para o controle de qualidade visual, sem executar a detecção novamente.
Passo 2: revisar, editar e anonimizar
Use a barra lateral de regiões para dispensar os falsos positivos (defina a ação como Cancelar), desenhe novas regiões para o que o modelo tiver deixado passar e depois clique em Transferir. O aplicativo para computador executa a anonimização e salva o PDF anonimizado na sua pasta Downloads.
8. SDK de Python (importação direta)
Para integrações avançadas, importe os módulos principais diretamente no seu código Python. Isso dá a você controle total sobre cada passo do processamento.
from promptshield import PromptShield
ps = PromptShield()
def process(input_path: str, output_path: str):
# Step 1 — Detect PII (runs the full local pipeline)
result = ps.detect(input_path)
print(f"Loaded: {result.file} ({result.pages} pages)")
print(f"Total PII entities: {result.total_regions}")
for page in result.regions:
for entity in page["entities"]:
print(f" Page {page['page']}: [{entity['type']}] {entity['text']}")
# Step 2 — Anonymize (reversible tokens by default; pass redact=True
# for permanent removal). Output is always a PDF.
out = ps.anonymize(input_path, output_path)
print(f"Anonymized: {out.tokens_created} tokens, saved to {out.output_file}")
# Step 3 — Restore the originals later from the local token vault
restored = ps.detokenize(output_path, "contract-restored.pdf")
print(f"Restored {restored.tokens_replaced} tokens")
process("contract.pdf", "contract-safe.pdf")
# Async variants are available too: ps.adetect / ps.aanonymize / ps.adetokenizeExemplo de processamento em lote
Processar vários arquivos em um diretório:
from pathlib import Path
from promptshield import PromptShield
ps = PromptShield()
def batch_process(input_dir: str, output_dir: str):
input_path = Path(input_dir)
output_path = Path(output_dir)
output_path.mkdir(parents=True, exist_ok=True)
files = list(input_path.glob("*.pdf"))
print(f"Processing {len(files)} files...")
for i, file in enumerate(files, 1):
print(f"[{i}/{len(files)}] {file.name}")
out_file = output_path / f"anon_{file.stem}.pdf"
result = ps.anonymize(str(file), str(out_file))
print(f" → {result.tokens_created} tokens, saved to {out_file.name}")
print("Batch complete!")
batch_process("./documents", "./anonymized")9. Segurança e privacidade dos dados
O promptShield foi projetado para ambientes de confiança zero:
10. Resolução de problemas
Problemas comuns e soluções:
Erro 'No spaCy model found' ou 'no NER model loaded'
Defina PROMPTSHIELD_ASSETS_DIR e instale um pacote: promptshield models install spacy-en-md. Como alternativa, para uma instalação em todo o sistema: python -m spacy download en_core_web_sm
O OCR não funciona em PDFs digitalizados
Instale o Tesseract OCR e verifique se ele está no seu PATH. No Windows, o instalador o adiciona automaticamente.
Os arquivos do Office não são convertidos
Arquivos do Word, Excel e PowerPoint (.docx, .xlsx, .xls, .pptx) são convertidos em Python, sem LibreOffice. Verifique se o extra office está instalado e se o arquivo não está protegido por senha.
'Invalid API key' na inicialização
Verifique se sua chave começa com ps_live_ e se sua assinatura está ativa. As chaves podem ser gerenciadas em /developers/api-keys.
Documentos
/api/documents/uploadEnviar documento
Envie um documento para processamento. Aceita arquivos PDF, DOCX, XLSX, PPTX e de imagem.
/api/documentsListar documentos
Retorna todos os documentos enviados, com o status de detecção e anonimização.
/api/documents/{id}Obter documento
Retorna informações detalhadas sobre um documento específico, incluindo o número de páginas e o status da detecção.
/api/documents/{id}Excluir documento
Remove um documento e todos os dados associados do servidor.
Detecção
/api/documents/{id}/detectDetectar dados pessoais
Executa o pipeline de detecção de dados pessoais em um documento. Aceita um corpo JSON opcional para substituir as configurações de detecção (confidence_threshold, regex_enabled, ner_enabled, regex_types etc.) apenas nesta execução.
/api/documents/{id}/redetectDetectar dados pessoais novamente
Executa a detecção novamente com controle total dos parâmetros. Aceita confidence_threshold, regex_types, ner_types, blacklist_terms e mais.
/api/documents/{id}/detection-progressProgresso da detecção
Retorna o progresso de uma tarefa de detecção em andamento (porcentagem, página atual e status).
/api/documents/{id}/regionsObter regiões
Retorna todas as regiões de dados pessoais detectadas em um documento, com tipo, texto, pontuação de confiança e caixa delimitadora.
/api/documents/{id}/regions/batch-actionAtualizar regiões em lote
Define a ação (TOKENIZE, REMOVE ou CANCEL) para várias regiões de uma só vez, filtradas por tipo de entidade.
Anonimizar e exportar
/api/documents/{id}/regions/syncSincronizar regiões
Substitui toda a lista de regiões de um documento. Use depois de editar as regiões no lado do cliente para enviar as alterações antes de anonimizar.
/api/documents/{id}/anonymizeAnonimizar documento
Anonimiza um documento substituindo os dados pessoais detectados por códigos. Retorna o documento processado.
/api/documents/{id}/download/{type}Baixar documento anonimizado
Baixa o resultado anonimizado. {type} é 'pdf' ou 'text'. O resultado sempre sai em PDF (entradas que não são PDF são convertidas), por isso 'pdf' é o formato principal.
/api/documents/batch-anonymizeAnonimizar em lote
Anonimiza vários documentos em uma única requisição: até 50 por requisição, processados 3 de cada vez.
Decodificar
/api/detokenizeDecodificar texto
Substitui os códigos em uma string de texto pelos valores originais do cofre.
/api/detokenize/fileDecodificar arquivo
Envie um documento codificado e receba uma versão com todos os códigos substituídos pelos valores originais.
Cofre e registro de códigos
/api/vault/statusStatus do cofre
Retorna as estatísticas do cofre: total de códigos, total de documentos, tamanho do registro.
/api/vault/tokensListar códigos
Retorna todas as correspondências entre código e original armazenadas no cofre.
/api/vault/exportExportar cofre
Exporta todo o cofre como arquivo JSON para backup ou migração.
/api/vault/importImportar cofre
Importa um JSON de cofre exportado anteriormente para restaurar as correspondências de códigos.
Integridade
/healthVerificação de integridade
Retorna o status de integridade do servidor. Use para monitoramento e sondas de integridade do balanceador de carga.
Configurações
/api/settingsObter configurações
Retorna a configuração atual de detecção e processamento (limiares, pipelines ativados, idioma etc.).
/api/settingsAtualizar configurações
Atualiza parcialmente as configurações globais de detecção. As alterações valem para todas as detecções seguintes.
/api/settings/patternsListar padrões personalizados
Retorna todos os padrões definidos pelo usuário usados na detecção personalizada de dados pessoais.
/api/settings/patternsCriar padrão personalizado
Adiciona um novo padrão personalizado à detecção de dados pessoais. Os padrões são avaliados junto com as regras integradas.
Exemplo
# 1. Upload a document
curl -X POST http://localhost:8000/api/documents/upload \
-F "file=@contract.pdf"
# → {"doc_id": "abc123", "filename": "contract.pdf", "page_count": 5, "status": "EXTRACTED"}
# 2. Run PII detection
curl -X POST http://localhost:8000/api/documents/abc123/detect
# → {"doc_id": "abc123", "total_regions": 42, "regions": [...]}
# 3. Get detected regions
curl http://localhost:8000/api/documents/abc123/regions
# → [{"id": "...", "pii_type": "PERSON", "text": "John Smith", "confidence": 0.98,
# "page_number": 1, "bbox": {...}, "source": "NER", "action": "TOKENIZE"}, ...]
# 4. Anonymize the document
curl -X POST http://localhost:8000/api/documents/abc123/anonymize
# → {"doc_id": "abc123", "tokens_created": 42, "regions_removed": 0}
# 5. Download anonymized PDF
curl -o contract-safe.pdf \
http://localhost:8000/api/documents/abc123/download/pdfSDK de Python
A classe PromptShield executa todo o pipeline localmente: detectar, anonimizar e decodificar em três chamadas. Todo o processamento acontece no seu dispositivo; nenhum dado dos documentos sai dele.
O SDK é distribuído com o pacote Python, que ainda não está no PyPI. Até lá, os endpoints HTTP acima fazem o mesmo trabalho.
from promptshield import PromptShield
ps = PromptShield()
# Detectar dados pessoais
result = ps.detect("contract.pdf")
print(f"{result.total_regions} entities across {result.pages} pages")
for page in result.regions:
for entity in page["entities"]:
print(f" [{entity['type']}] {entity['text']}")
# Anonimizar (tokenização reversível)
out = ps.anonymize("contract.pdf", "contract-safe.pdf")
print(f"Done: {out.tokens_created} tokens created")
# Restaurar os valores originais
restored = ps.detokenize("contract-safe.pdf", "contract-restored.pdf")
print(f"Restored {restored.tokens_replaced} tokens")Tratamento de erros
Todas as respostas de erro seguem um formato JSON padrão, com um campo detail que descreve o erro.
Requisição inválida. Parâmetros incorretos ou arquivo corrompido / não suportado.
Não autorizado. Chave de API ausente ou inválida (Authorization: Bearer) no modo de chave de API.
Proibido. A chave de API não tem o escopo necessário (detect / anonymize / detokenize).
Não encontrado. O ID do documento não existe.
Não processável. Falta um campo obrigatório ou o arquivo está protegido por senha.
Erro do servidor. Consulte os logs do servidor para mais detalhes.
Um modelo de detecção necessário não está instalado. Instale com promptshield models install.
{
"detail": "Document not found: abc123"
}Limites de taxa
Por padrão, a API auto-hospedada aceita até 6.000 requisições por minuto por IP de cliente. Para mudar esse limite, defina a variável de ambiente PROMPTSHIELD_SELF_HOSTED_RATE.