> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Use a documentação do CometAPI com LLMs

> Use o llms.txt e o llms-full.txt do CometAPI com assistentes de programação, sistemas de recuperação e prompts de modelo.

Use `llms.txt` quando precisar de um índice compacto das páginas de documentação do CometAPI. Use `llms-full.txt` quando sua ferramenta puder ingerir o texto completo da documentação para recuperação, resposta a perguntas ou assistência de programação.

## Obter o índice compacto

A solicitação a seguir baixa o índice `llms.txt` do CometAPI:

```bash theme={null}
curl https://apidoc.cometapi.com/llms.txt
```

A resposta começa com o título da documentação e a lista de páginas com links:

```text theme={null}
# CometAPI Documentation

> CometAPI developer documentation for unified API access...

## Docs

- [Create a new API key](https://apidoc.cometapi.com/api/api-keys/create-api-key.md)
```

## Obter o texto completo

A solicitação a seguir baixa a exportação de texto completo:

```bash theme={null}
curl https://apidoc.cometapi.com/llms-full.txt
```

A resposta contém o conteúdo das páginas agrupado por URL de origem:

```text theme={null}
# Create a new API key
Source: https://apidoc.cometapi.com/api/api-keys/create-api-key

Create a new CometAPI API key for the authenticated account.
```

## Adicionar a documentação a um trabalho de recuperação

O exemplo em Python a seguir baixa o texto completo e o grava em um arquivo local para indexação:

```python theme={null}
from pathlib import Path

import requests

url = "https://apidoc.cometapi.com/llms-full.txt"
response = requests.get(url, timeout=60)
response.raise_for_status()

Path("cometapi-docs.txt").write_text(response.text, encoding="utf-8")
print(len(response.text))
```

O resultado é o número de caracteres salvos. Esta é apenas uma saída de exemplo; seu valor será diferente sempre que a documentação mudar:

```text theme={null}
449946
```

## Erros comuns

| Error                                    | Fix                                                                                    |
| ---------------------------------------- | -------------------------------------------------------------------------------------- |
| O contexto da ferramenta é muito pequeno | Use `llms.txt` primeiro e, em seguida, baixe apenas as páginas com links que importam. |
| O texto completo é muito grande          | Divida `llms-full.txt` por heading ou URL de origem antes de indexar.                  |
| Cache local corrompido                   | Atualize o arquivo durante o job de sincronização da documentação.                     |
| Página ausente nos resultados de AI      | Confirme se a página aparece na navegação e em `llms.txt`.                             |

## Links relacionados

* [Página inicial da documentação do CometAPI](/)
* [Página de modelos](/pt/overview/models)
* [Diretório de modelos](https://www.cometapi.com/models/)
* [Preços](https://www.cometapi.com/pricing/)
* [Quickstart do CometAPI](/pt/overview/quick-start)

<script type="application/ld+json">
  {`
    {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "TechArticle",
        "@id": "https://apidoc.cometapi.com/guides/how-to-use-cometapi-docs-with-llms",
        "headline": "Como uso a documentação do CometAPI com LLMs?",
        "description": "Use o llms.txt e o llms-full.txt do CometAPI com assistentes de programação, sistemas de recuperação e prompts de modelo.",
        "url": "https://apidoc.cometapi.com/guides/how-to-use-cometapi-docs-with-llms",
        "author": {
          "@type": "Organization",
          "name": "CometAPI"
        },
        "publisher": {
          "@type": "Organization",
          "name": "CometAPI",
          "url": "https://www.cometapi.com"
        }
      },
      {
        "@type": "BreadcrumbList",
        "itemListElement": [
          {
            "@type": "ListItem",
            "position": 1,
            "name": "Documentação do CometAPI",
            "item": "https://apidoc.cometapi.com/"
          },
          {
            "@type": "ListItem",
            "position": 2,
            "name": "Guias",
            "item": "https://apidoc.cometapi.com/guides/use-cometapi-with-openai-sdk"
          },
          {
            "@type": "ListItem",
            "position": 3,
            "name": "Como uso a documentação do CometAPI com LLMs?",
            "item": "https://apidoc.cometapi.com/guides/how-to-use-cometapi-docs-with-llms"
          }
        ]
      }
    ]
    }
    `}
</script>