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

# Documentação para IA

# Documentação para IA: use a Sorsa API com LLMs

A documentação da Sorsa foi preparada para assistentes de IA e grandes modelos de linguagem. Forneça a referência completa a ChatGPT, Claude, Grok, Cursor, Copilot ou outro LLM para obter respostas, gerar integrações e investigar problemas sem consultar cada página manualmente.

## O arquivo de documentação para IA

Mantemos um arquivo em inglês, `sorsa_api_v3_documentation_en.txt`, com a especificação completa: endpoints, parâmetros, esquemas de resposta e autenticação.

[Documentação completa em texto simples](https://api.sorsa.io/v3/static/sorsa_api_v3_documentation_en.txt)

Anexe o arquivo ou adicione-o ao contexto do projeto. Se ultrapassar o limite de contexto da ferramenta, use o [índice da documentação](https://docs.sorsa.io/llms.txt) para selecionar as páginas de endpoints e conceitos necessárias.

## Como usar

**ChatGPT / Claude / Grok / Gemini:** cole o conteúdo ou anexe o arquivo no início da conversa. Depois peça, por exemplo: “Escreva um script Python que busque publicações sobre IA e exporte para CSV” ou “Como percorrer todos os seguidores de uma conta com paginação?”.

**Cursor / Copilot / Claude Code / Codex / Windsurf:** adicione o arquivo ao contexto ou mencione-o no prompt. Peça que o assistente siga URLs, parâmetros, cabeçalhos e esquemas documentados. Confira o código gerado na referência e teste uma requisição pequena antes de executar um lote.

**GPTs personalizados e assistentes:** envie o arquivo como base de conhecimento ao criar um assistente que consulte dados do X/Twitter pela Sorsa.

## O que está incluído

* URL base, autenticação e códigos de erro comuns.
* Modelos compartilhados (User, Tweet, Follower, Space e outros), com nomes e tipos de campos.
* Endpoints por categoria, métodos HTTP e parâmetros obrigatórios e opcionais.
* Exemplos de requisições e respostas.
* Paginação, ordenação, limites por requisição e formatos de data.
* Sintaxe de busca, operadores comuns e link para a referência completa.
* Casos especiais e diferenças entre objetos, como `view_count` em Tweet e `views_count` em Article.

O arquivo é atualizado conforme a API evolui.

## Por que fornecer a documentação

Sem contexto correto, um LLM pode inventar parâmetros ou campos e usar padrões antigos. A referência reduz essas suposições, mas o código gerado ainda precisa ser validado. Confira método HTTP, campos enviados, estrutura da resposta, paginação e tratamento de erros antes de usar.

## Próximos passos

Você precisa de uma chave para executar o código gerado. Cada conta nova inclui 100 requisições gratuitas, sem cartão.

* [Início rápido](https://docs.sorsa.io/pt-BR/quickstart): obtenha a chave e faça a primeira requisição.
* [Autenticação](https://docs.sorsa.io/pt-BR/authentication): envie a chave corretamente.
* [Referência da API](https://docs.sorsa.io/pt-BR/api-reference-guide): consulte a especificação pelo navegador.