Skip to main content

​
Documentación preparada para IA: utiliza Sorsa API con LLM

La documentación de Sorsa está preparada para asistentes de IA y modelos de lenguaje. Puedes proporcionar la referencia completa a ChatGPT, Claude, Grok, Cursor, Copilot u otro LLM para consultar la API, generar código de integración y diagnosticar problemas sin recorrer manualmente todas las páginas.

​
El archivo de documentación para IA

Mantenemos un archivo legible por máquinas, sorsa_api_v3_documentation_en.txt, que reúne la especificación completa en inglés: endpoints, parámetros, esquemas de respuesta y autenticación. https://api.sorsa.io/v3/static/sorsa_api_v3_documentation_en.txt Adjunta el archivo o añádelo al contexto de tu proyecto. Si supera la capacidad de contexto de tu herramienta, utiliza el índice de documentación para seleccionar los endpoints y las páginas de conceptos comunes que necesites.

​
Cómo utilizarlo

ChatGPT / Claude / Grok / Gemini: copia el contenido o adjunta el archivo al inicio de la conversación. Después, pide algo como «Escribe un script de Python que busque publicaciones sobre IA y las exporte a CSV» o «¿Cómo recorro todas las páginas de seguidores de una cuenta?». Cursor / Copilot / Claude Code / Codex / Windsurf: añade el archivo al contexto del proyecto o menciónalo en el prompt. Pide al asistente que utilice las URL, parámetros, encabezados y esquemas documentados. Revisa el código generado frente a la referencia y prueba una solicitud pequeña antes de ejecutar un trabajo por lotes. GPTs personalizados y asistentes: sube el archivo como fuente de conocimiento al crear un asistente que deba trabajar con datos de X/Twitter mediante Sorsa.

​
Qué contiene

El archivo ofrece una referencia estructurada de toda la API:
  • URL base, método de autenticación y errores habituales.
  • Modelos compartidos (User, Tweet, Follower, Space y otros), con los nombres y tipos de sus campos.
  • Rutas de endpoints agrupadas por categoría, con método HTTP y parámetros obligatorios y opcionales.
  • Ejemplos de solicitudes y respuestas de cada endpoint.
  • Paginación, opciones de ordenación, límites por solicitud y formatos de fecha.
  • Sintaxis de búsqueda, operadores habituales y enlace a la referencia completa.
  • Casos especiales y diferencias entre respuestas, como los nombres de campos de Tweet y Article: por ejemplo, view_count frente a views_count.
El archivo se actualiza a medida que evoluciona la API para reflejar la especificación actual.

​
Por qué es útil

Los LLM dependen del contexto disponible. Sin documentación precisa, un asistente puede adivinar nombres de parámetros, inventar campos o utilizar patrones obsoletos. Proporcionar la referencia reduce estas suposiciones, pero el código generado sigue necesitando validación. Comprueba el método HTTP, los campos de la solicitud, la estructura de respuesta, la paginación y la gestión de errores antes de utilizarlo.

​
Próximos pasos

Necesitas una clave de API para ejecutar el código generado. Cada cuenta nueva incluye 100 solicitudes gratuitas sin tarjeta de crédito, para que puedas probarlo de inmediato.