SETTO API

Documentación para LLMs

Cada página de esta documentación está disponible como Markdown crudo, más llms.txt, llms-full.txt y openapi.json — los artefactos legibles por máquina que necesita un agente de IA o un pipeline RAG.

Esta documentación está escrita para leerse dos veces: una por ti y otra por un modelo. Cada página tiene un gemelo en Markdown crudo, el sitio completo está disponible como dos paquetes de texto plano, y el contrato de la API se publica como OpenAPI. Sin scraping, sin renderizar JavaScript, sin API key.

Los cuatro artefactos

URLQué esPara qué sirve
/llms.txtUn índice: una línea por página, con su título y descripciónDejar que un agente decida qué traer
/llms-full.txtEl Markdown de cada página concatenado en un solo documentoMeter toda la documentación en una ventana de contexto
<page>.mdCualquier página como Markdown crudoTraer exactamente la página que necesitas
/openapi.jsonLa descripción OpenAPI 3 de los seis endpointsGenerar un cliente, o alimentar a un modelo con tool calling

llms.txt y llms-full.txt

/llms.txt sigue la convención llms.txt: un índice corto del sitio en Markdown, una viñeta por página, barato de traer y barato de leer. Empieza ahí cuando quieras que un modelo elija su propia lectura.

curl -s https://docs.setto.io/llms.txt

/llms-full.txt es el mismo sitio con los cuerpos incluidos — cada guía, cada página de conceptos y toda la referencia generada en una sola respuesta. Es la forma de darle todo a un modelo en una sola petición:

curl -s https://docs.setto.io/llms-full.txt

Ambos describen el sitio canónico en inglés. Las páginas en español viven bajo /es/docs/… y tienen los mismos gemelos .md.

Cualquier página como Markdown

Agrega .md a una URL de la documentación y obtienes el Markdown fuente en lugar de la página renderizada:

curl -s https://docs.setto.io/docs/concepts/populate.md
curl -s https://docs.setto.io/docs/guides/get-round.md
curl -s https://docs.setto.io/es/docs/quickstart.md

Las páginas generadas de la referencia también funcionan. Su forma renderizada es un componente interactivo, así que el gemelo en Markdown se arma desde el documento OpenAPI — método y ruta, autenticación, una tabla de parámetros, la tabla de respuesta y un ejemplo con curl:

curl -s https://docs.setto.io/docs/reference/tournaments/list-tournaments.md

Acciones de copiar y abrir en IA

Cada página lleva dos controles debajo de su título:

  • Copy Markdown — pone el Markdown crudo de esa página en tu portapapeles, listo para pegarlo en un chat.
  • View options — la misma página como Markdown en una pestaña nueva, o abierta directamente en ChatGPT, Claude u otro asistente con un prompt que referencia la URL.

Son la versión de un clic de los comandos curl de arriba; usa el que te acomode.

/openapi.json

curl -s https://docs.setto.io/openapi.json

El documento a partir del cual se genera la referencia de la API, con servers[0].url ya apuntando al host de la API en vivo. Seis operaciones, con operationIds estables — getMe, listTournaments, getTournament, listDivisions, listTeams, getRound — así que un cliente generado o un modelo con tool calling obtiene los mismos nombres que usan las guías.

Para quienes construyen RAG

Algunas propiedades en las que vale la pena apoyarse:

  • Las URLs son estables. La ruta de una página es su identidad; no renumeramos páginas ni rebarajamos secciones debajo de una URL. Guarda la URL como la cita de un chunk y va a seguir apuntando al mismo material.
  • .md es el texto canónico. Indexa el gemelo en Markdown, no el HTML renderizado — sin cromo de navegación, sin texto duplicado de la barra lateral, y los encabezados se mapean limpiamente a los chunks.
  • Los encabezados tienen sentido. Cada página empieza con un párrafo de resumen bajo el título y luego secciones ## que se sostienen solas. Parte en ## y cada chunk sigue siendo respondible.
  • Recrawlea barato. Trae /llms.txt y haz diff para ver qué páginas existen; trae /llms-full.txt cuando quieras todo en una sola petición.
  • La referencia es generada. /docs/reference/** se produce desde /openapi.json. Si estás indexando para preguntas sobre la API, el documento OpenAPI es la fuente más densa y confiable.
  • Dos idiomas, un árbol de contenido. El inglés va sin prefijo, el español bajo /es/. Las páginas que todavía no tienen traducción al español caen de vuelta al texto en inglés en la URL en español, así que trata los duplicados /es/… como el mismo documento.

Relacionado

En esta página