Public facts an agent can read without guessing.
The public API describes Workforce AI, its current capabilities, integrations, and canonical content. It does not expose customer accounts. Authenticated write access will be documented only when the product authorization layer is live.
Read-only endpoints
No key is required. Responses allow cross-origin reads, support GET and HEAD, and are cached from the same canonical fact source used by the site.
GET/api/public/v1/healthPublic information API status and documentation pointer.GET/api/public/v1/product-factsCanonical company, product, pricing, security, and positioning facts.GET/api/public/v1/capabilitiesCurrent capability summaries and meeting-platform status.GET/api/public/v1/integrationsCurrent public integration list with provider-specific documentation links.GET/api/public/v1/content-indexCanonical sitemap URLs and machine-discovery resources.Predictable files
These resources are public, canonical, and suitable for search systems, answer engines, evaluators, and agent tooling.
- /openapi.jsonTyped OpenAPI 3.1 contract for the public information API.
- /llms.txtConcise product and content map for language models.
- /llms-full.txtExpanded capability, boundary, and content reference.
- /product-facts.jsonCanonical company and product fact document.
- /sitemap.xmlCanonical indexable page inventory with language alternates.
Versioned from the first request.
The canonical public API uses /api/public/v1/. Every response includes API-Version: 1 and X-API-Version: 1.
New optional fields may be added within v1. Existing fields keep their documented meaning and type.
A breaking contract change receives a new major path, such as /v2/, with a migration note.
Deprecated routes return Deprecation, Sunset, and Link: rel="successor-version" headers for at least six months.
Unversioned API aliases remain compatible through February 28, 2027. After that date, requests to /api/public/... may return 410 Gone.
Failures an agent can handle.
Error responses use one stable object with a machine code, plain-language message, retry signal, and documentation URL. Temporary failures also return 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"
}
}Least privilege before launch.
Authenticated customer data and write actions are not public yet. The connector platform is being designed around explicit consent, narrow scopes, workspace isolation, idempotent writes, audit records, and human review. None of the scopes below can be requested from production today.
account.profile.readRead the connected account profile and setup state.
Planned, not publicmeetings.readRead meetings the user has authorized.
Planned, not publictasks.readRead authorized tasks and status.
Planned, not publicdrafts.readRead authorized draft content.
Planned, not publicdrafts.writeCreate or revise drafts, with review rules preserved.
Planned, not publictasks.writeCreate or update tasks with idempotency and audit controls.
Planned, not publicWhat agents may do today
Available: retrieve public facts, capabilities, integrations, canonical URLs, Markdown page variants, and the OpenAPI contract.
Not public: read a customer account, list meetings, create drafts, change tasks, send messages, or authorize a Workforce AI workspace.
For product integration questions, email m@hireworkforce.ai.
