Datos públicos que un agente puede leer sin adivinar.
La API pública describe Workforce AI, sus capacidades actuales, sus integraciones y su contenido canónico. No expone las cuentas de los clientes. El acceso de escritura autenticado se documentará únicamente cuando la capa de autorización del producto esté en funcionamiento.
Endpoints de solo lectura
No se requiere clave. Las respuestas permiten lecturas de origen cruzado, admiten GET y HEAD, y se almacenan en caché desde la misma fuente canónica de datos que usa el sitio.
GET/api/public/v1/healthEstado de la API de información pública y puntero a la documentación.GET/api/public/v1/product-factsDatos canónicos de empresa, producto, precios, seguridad y posicionamiento.GET/api/public/v1/capabilitiesResúmenes de capacidades actuales y estado de las plataformas de reuniones.GET/api/public/v1/integrationsLista actual de integraciones públicas con enlaces a la documentación específica de cada proveedor.GET/api/public/v1/content-indexURLs canónicas del sitemap y recursos de descubrimiento por máquina.Archivos predecibles
Estos recursos son públicos, canónicos y adecuados para sistemas de búsqueda, motores de respuesta, evaluadores y herramientas de agentes.
- /openapi.jsonContrato tipado OpenAPI 3.1 para la API pública de información.
- /llms.txtMapa conciso de producto y contenido para modelos de lenguaje.
- /llms-full.txtReferencia ampliada de capacidades, límites y contenido.
- /product-facts.jsonDocumento canónico de datos de la empresa y del producto.
- /sitemap.xmlInventario canónico de páginas indexables con alternativas de idioma.
Versionada desde la primera solicitud.
La API pública canónica usa /api/public/v1/. Cada respuesta incluye API-Version: 1 y X-API-Version: 1.
Se pueden agregar nuevos campos opcionales dentro de v1. Los campos existentes conservan su significado y tipo documentados.
Un cambio que rompe el contrato recibe una nueva ruta principal, como /v2/, con una nota de migración.
Las rutas obsoletas devuelven Deprecation, Sunset, y Link: rel="successor-version" encabezados durante al menos seis meses.
Los alias de API sin versión seguirán siendo compatibles hasta el 28 de febrero de 2027. Después de esa fecha, las solicitudes a /api/public/... puede devolver 410 Gone.
Fallos que un agente puede manejar.
Las respuestas de error usan un único objeto estable con un código legible por máquina, un mensaje en lenguaje sencillo, una señal de reintento y una URL de documentación. Los fallos temporales también devuelven Retry-After.
{
"error": {
"code": "public_facts_unavailable",
"message": "The canonical public fact source is temporarily unavailable.",
"retryable": true,
"documentation": "https://www.hireworkforce.ai/developers#api-errors"
}
}Privilegio mínimo antes del lanzamiento.
Los datos de cliente autenticados y las acciones de escritura aún no son públicos. La plataforma de conectores se está diseñando en torno al consentimiento explícito, alcances acotados, aislamiento de espacios de trabajo, escrituras idempotentes, registros de auditoría y revisión humana. Ninguno de los alcances a continuación puede solicitarse desde producción hoy.
account.profile.readLeer el perfil de la cuenta conectada y su estado de configuración.
Planificado, no públicomeetings.readLeer las reuniones que el usuario ha autorizado.
Planificado, no públicotasks.readLeer tareas y estado autorizados.
Planificado, no públicodrafts.readLeer contenido de borradores autorizado.
Planificado, no públicodrafts.writeCrea o revisa borradores, conservando las reglas de revisión.
Planificado, no públicotasks.writeCrea o actualiza tareas con controles de idempotencia y auditoría.
Planificado, no públicoLo que los agentes pueden hacer hoy
Disponible: obtener datos públicos, capacidades, integraciones, URLs canónicas, variantes de página en Markdown y el contrato OpenAPI.
No público: leer la cuenta de un cliente, listar reuniones, crear borradores, cambiar tareas, enviar mensajes ni autorizar un espacio de trabajo de Workforce AI.
Para preguntas sobre integración de productos, escribe a m@hireworkforce.ai.
