Visión general
La API HTTP de typesearch, versión 1: dirección base, autenticación, errores y versiones.
Dirección base
https://api.typesearch.aiTodos los endpoints viven bajo /v1. Los pedidos y las respuestas son JSON
(Content-Type: application/json); los nombres de campo van en snake_case.
Autenticación
Envía tu key como Authorization: Bearer ts_live_… o x-api-key: ts_live_…. Mira
Autenticación.
Identificación del cliente
Si quieres, indica qué librería o integración hace el pedido con
X-Typesearch-Client: <nombre>/<versión> (por ejemplo mi-agente/1.2.0). Los SDK y las integraciones
oficiales lo mandan solos. Sólo se usa para estadísticas de uso agregadas: nunca cambia la autenticación, el
cobro ni los límites.
Endpoints
| Endpoint | ||
|---|---|---|
| POST | /v1/search | Busca en el índice. |
| POST | /v1/search/site | Busca en un sitio en vivo. Devuelve un trabajo. |
| GET | /v1/jobs/{id} | El estado y el resultado de un trabajo. |
| POST | /v1/similar | Notas sobre la misma noticia que una URL. |
| POST | /v1/contents | Metadatos y fragmentos de hasta 10 URLs. |
| POST | /v1/charts | Crea una tarjeta de gráfico. |
| GET | /v1/charts | Lista tus gráficos. |
| GET | /v1/charts/{id} | Un gráfico. |
| PATCH | /v1/charts/{id} | Cambia su tipo, tema, título o idioma. Gratis. |
| DELETE | /v1/charts/{id} | Borra un gráfico. |
| GET | /embed/{file} | El embed, la PNG o el SVG públicos de un gráfico. Sin key. |
| GET | /v1/usage | El uso y los límites de tu key. |
Errores
Los errores son problem details del RFC 9457 con un code
estable. Mira Errores para todos los códigos, y Límites para los
encabezados de límites.
Versiones
/v1 sólo cambia agregando: campos nuevos en las respuestas y opciones nuevas con un valor por defecto. Lo
que rompa saldrá como /v2, con aviso. Ignora los campos que no conozcas, y no envíes campos que no estén
documentados: los campos desconocidos se rechazan.
OpenAPI
Todo el contrato es un documento OpenAPI 3.1, generado de los mismos esquemas que validan cada pedido. Úsalo para generar un cliente en cualquier lenguaje, o para importar la API en tus herramientas.