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

# Visão geral

> Como ler esta referência: o que é contrato público e o que é superfície interna documentada.

Esta referência é gerada a partir de `openapi.json`, que por sua vez é exportado
diretamente do código que serve a API (`workers/openapi.ts`). Não é uma cópia
mantida à mão: o mesmo documento é servido ao vivo em
[`/api/openapi.json`](https://tryno.io/api/openapi.json).

## Leia por `tag`

<CardGroup cols={2}>
  <Card title="platform" icon="key">
    **Platform API v1** — `/v1/*`. Público, estável, somente leitura,
    autenticado por `Authorization: Bearer tryno_sk_…`. É o contrato que
    integrações devem usar.
  </Card>

  <Card title="platform-admin" icon="gear">
    Plano de controle: criar/revogar chaves, registrar webhooks, ler o log de
    entregas. Autenticado por **sessão**, e só para dono/administrador da tribo.
  </Card>
</CardGroup>

Todas as demais tags (`communities`, `feed`, `courses`, `payments`, `wallet`…)
descrevem a **API da aplicação**: os endpoints que o app web da Tryno consome,
autenticados por cookie de sessão.

<Warning>
  A API da aplicação está documentada por transparência, não como contrato.
  Ela pode mudar sem aviso e sem versionamento. Se você está construindo uma
  integração, use `/v1` — e se algo de que você precisa só existe fora dela,
  fale conosco em vez de acoplar ao endpoint interno.
</Warning>

## Autenticação nesta referência

O ícone de cadeado indica que o endpoint exige autenticação. Qual delas depende
do esquema declarado:

| Esquema      | Como enviar                                     | Onde se aplica |
| ------------ | ----------------------------------------------- | -------------- |
| `bearerAuth` | `Authorization: Bearer tryno_sk_…`              | `/v1/*`        |
| `cookieAuth` | Cookie `__session` (ou a ponte `tryno_session`) | Todo o resto   |

Detalhes em [Criar API key](/guides/api-keys).

<Warning>
  A `/api/v1` **não envia cabeçalhos CORS**. O "Try it" desta referência e
  qualquer chamada feita direto do navegador em outra origem serão bloqueados
  pelo browser. Teste a partir do seu servidor, de um cliente HTTP local ou de
  `curl` — nunca do front-end, que também não é lugar para uma chave
  `tryno_sk_`.
</Warning>

## O que vale para toda a `/v1`

| Convenção         | Valor                                                                             |
| ----------------- | --------------------------------------------------------------------------------- |
| Base              | `https://tryno.io/api`                                                            |
| Métodos           | Somente `GET` — a v1 é read-only                                                  |
| Escopo de dados   | Uma tribo por chave, resolvida a partir da própria credencial                     |
| Paginação         | `page` (≥1) e `pageSize` (1–100, padrão 25) — ver [Paginação](/guides/pagination) |
| Envelope de lista | `{ object: "list", data, page, pageSize, hasMore }`                               |
| Envelope de erro  | `{ error: { type, message } }` — ver [Erros e limites](/guides/errors)            |
| Limite            | 120 requisições/min por chave; `Retry-After: 60` no `429`                         |
| Dinheiro          | Inteiro em centavos + campo de moeda separado                                     |
| Datas             | ISO-8601 em UTC                                                                   |

## Precisão desta referência

Sendo transparente sobre a profundidade do documento: **os caminhos, métodos,
tags e esquemas de segurança são completos** — cobrem toda rota montada em
`workers/api.ts`. Já os *schemas* de requisição e resposta são detalhados para
os endpoints de maior tráfego e para toda a `/v1`; em vários endpoints internos
o corpo aparece como objeto genérico (`additionalProperties: true`).

É um mapa completo da superfície, não um contrato estrito campo a campo. Para
`/v1`, que é a parte que terceiros consomem, os envelopes de lista, os escopos e
os erros estão descritos por inteiro.