---
title: "Como usar esta documentação com agentes de IA"
description: "Como agentes de IA de programação leem esta documentação: llms.txt, versão em Markdown de cada página, referências rápidas, especificações OpenAPI e catálogos."
canonical: "https://docs.lacunasoftware.com/articles/welcome/using-with-ai-agents"
locale: "pt-BR"
product: "Bem-vindo"
last_updated: "2026-10-12"
---

# Como usar esta documentação com agentes de IA

Quando um agente de IA de programação (Claude Code, Cursor, GitHub Copilot, Codex…) escreve a sua integração,
indique a ele os recursos abaixo. Eles têm o mesmo conteúdo das páginas que você lê, em formatos que um agente
baixa e interpreta com facilidade. A [última seção](https://docs.lacunasoftware.com/articles/welcome/using-with-ai-agents#um-parágrafo-para-o-seu-agente) traz um parágrafo pronto para colar nas
instruções do seu agente.

## Comece pelo llms.txt

| Arquivo | O que contém |
|---|---|
| [llms.txt](https://docs.lacunasoftware.com/llms.txt) | Índice das páginas em inglês, agrupadas por produto, cada uma com a URL em Markdown e uma descrição de uma linha. A referência rápida de cada produto vem primeiro. As páginas que ainda não existem em inglês apontam para a versão em português, marcadas com (pt-br). Termina com as especificações OpenAPI. |
| [llms-full.txt](https://docs.lacunasoftware.com/llms-full.txt) | As mesmas páginas na íntegra, num só arquivo, cada uma sob um título com a sua URL. |
| [pt-br/llms.txt](https://docs.lacunasoftware.com/pt-br/llms.txt), [pt-br/llms-full.txt](https://docs.lacunasoftware.com/pt-br/llms-full.txt) | O mesmo para as páginas em português. |

Os dois seguem o formato [llms.txt](https://llmstxt.org/).

## Cada página em Markdown

Acrescente `.md` à URL de qualquer página para obtê-la em Markdown puro. Por exemplo,
https://docs.lacunasoftware.com/articles/signer/get-started.md é a versão em Markdown de
https://docs.lacunasoftware.com/articles/signer/get-started.

- O front matter traz o título, a descrição, a URL canônica, o idioma, o produto e a data da última alteração.
- As abas viram um bloco de código por aba, cada um com um rótulo em negrito; observações e avisos viram
  citações; links e imagens são URLs absolutas.
- Cada página aponta para a sua versão em Markdown no head do HTML (`<link rel="alternate" type="text/markdown">`)
  e abaixo do conteúdo (**Ver em Markdown**, **Copiar página em Markdown**).
- A referência da API .NET do PKI SDK funciona do mesmo jeito: https://docs.lacunasoftware.com/api/Lacuna.Pki/PKCertificate.md.

## Referências rápidas

Uma página por produto com o que uma integração precisa primeiro: instalação, configuração e autenticação,
operações principais com código, erros, certificados de teste, demonstrações e exemplos. O que a documentação
ainda não cobre fica marcado como `TODO(docs)` em vez de ser deduzido.

- [Web PKI](https://docs.lacunasoftware.com/articles/web-pki/quick-reference)
- [Rest PKI Core](https://docs.lacunasoftware.com/articles/rest-pki/core/quick-reference)
- [PKI Express](https://docs.lacunasoftware.com/articles/pki-express/quick-reference)
- [PKI SDK](https://docs.lacunasoftware.com/articles/pki-sdk/quick-reference)
- [Signer](https://docs.lacunasoftware.com/articles/signer/quick-reference)
- [Amplia](https://docs.lacunasoftware.com/articles/amplia/quick-reference)
- [Rest PKI (legado)](https://docs.lacunasoftware.com/articles/rest-pki/quick-reference)

Em dúvida sobre qual produto usar? Veja [Como escolher um produto](https://docs.lacunasoftware.com/articles/welcome/choosing-a-product).

## Especificações das APIs

A especificação OpenAPI de cada API em nuvem é copiada para uma URL estável neste site. As instâncias on-premises
servem a sua própria em `/swagger`.

| API | Especificação | Especificação ao vivo |
|---|---|---|
| Rest PKI Core | [openapi/rest-pki-core.json](https://docs.lacunasoftware.com/openapi/rest-pki-core.json) | https://core.pki.rest/swagger/api/swagger.json |
| Signer | [openapi/signer.json](https://docs.lacunasoftware.com/openapi/signer.json) | https://www.dropsigner.com/swagger/api/swagger.json |
| Amplia | [openapi/amplia.json](https://docs.lacunasoftware.com/openapi/amplia.json) | https://amplia.lacunasoftware.com/swagger/api/swagger.json |
| Amplia Reg | [openapi/amplia-reg.json](https://docs.lacunasoftware.com/openapi/amplia-reg.json) | https://ar.lacunasoftware.com/swagger/api/swagger.json |
| CloudHub | [openapi/cloudhub.json](https://docs.lacunasoftware.com/openapi/cloudhub.json) | https://cloudhub.lacunasoftware.com/swagger/v1/swagger.json |
| Digiploma | [openapi/digiploma.json](https://docs.lacunasoftware.com/openapi/digiploma.json) | https://www.digiploma.com.br/swagger/api/swagger.json |
| Scanner | [openapi/scanner.json](https://docs.lacunasoftware.com/openapi/scanner.json) | https://scn.lacunasoftware.com/swagger/api/swagger.json |
| Rest PKI (legado) | [openapi/rest-pki.json](https://docs.lacunasoftware.com/openapi/rest-pki.json) | https://pki.rest/swagger/docs/v1 |

## Demonstrações e exemplos

- **Demonstrações**: https://try.lacunasoftware.com/demos.json lista as demonstrações de
  [try.lacunasoftware.com](https://try.lacunasoftware.com/pt), com o produto, a página da documentação e os
  exemplos de cada uma.
- **Exemplos**: os repositórios [PkiSuiteSamples](https://github.com/LacunaSoftware/PkiSuiteSamples) e
  [SignerSamples](https://github.com/LacunaSoftware/SignerSamples) mantêm cada um um catálogo `samples.json`: uma
  entrada por tarefa e linguagem, com o arquivo a ler, como executá-lo, a página da documentação e a demonstração.
- As páginas que tratam de uma tarefa terminam com um quadro **Demonstrações e exemplos** que aponta para a
  demonstração e para o exemplo em cada linguagem.

## Um parágrafo para o seu agente

Cole isto nas instruções do seu agente (por exemplo `CLAUDE.md`, `AGENTS.md` ou `.cursor/rules`) e diga qual
produto você usa. O texto fica em inglês, o idioma mais completo da documentação:

```text
This project integrates Lacuna Software products (digital certificates, digital signatures, PKI).
Use the official docs at https://docs.lacunasoftware.com and read them as Markdown:
- Start with https://docs.lacunasoftware.com/llms.txt, the index of all pages by product.
- Add ".md" to any docs page URL to get its Markdown version.
- Read the product's quick reference first (listed first under the product in llms.txt): packages,
  configuration, core operations, errors and samples.
- For REST APIs, use the OpenAPI specs at https://docs.lacunasoftware.com/openapi/ (listed at the
  end of llms.txt).
- For working code, follow the samples linked from the docs pages (PkiSuiteSamples and
  SignerSamples on GitHub) in this project's language.
Do not guess package names, versions, endpoints or headers: take them from the quick reference, the
OpenAPI spec or a sample. When developing, use the test certificates from
https://docs.lacunasoftware.com/en-us/articles/pki-guide/test-certs, never production certificates.
```