Knowledge Hub web services for everyone
The web services in the following table do not require authentication, but authenticated users can get different results than unauthenticated users. For example, a portal can have an access rule prohibiting access to a category of documents to authenticated users.
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| GET | /api/khub/maps |
List maps | No |
| GET | /api/khub/maps/{mapId} |
Get a map | No |
| GET | /api/khub/maps/{mapId}/toc |
Get a map's table of contents | No |
| POST | /api/khub/maps/search |
Search maps | No |
| GET | /api/khub/maps/{mapId}/resources |
List a map's resources | No |
| GET | /api/khub/maps/{mapId}/resources/{resourceId} |
Get the metadata of a map's resource | No |
| GET | /api/khub/maps/{mapId}/resources/{resourceId}/content |
Get the content of a map's resource | No |
| GET | /api/khub/maps/{mapId}/rating |
Get a map's rating | No |
| POST | /api/khub/maps/{mapId}/rating |
Rate a map | No |
| DELETE | /api/khub/maps/{mapId}/rating |
Delete a map's rating | No |
| POST | /api/khub/maps/{mapId}/feedback |
Send feedback about a map | No |
| GET | /api/khub/maps/{mapId}/topics |
List a map's topics | No |
| GET | /api/khub/maps/{mapId}/topics/{contentId} |
Get a topic | No |
| GET | /api/khub/maps/{mapId}/topics/{contentId}/content |
Get a topic's content | No |
| POST | /api/khub/maps/{mapId}/topics/{tocId}/rating |
Rate a topic | No |
| DELETE | /api/khub/maps/{mapId}/topics/{tocId}/rating |
Delete a topic's rating | No |
| POST | /api/khub/maps/{mapId}/topics/{tocId}/feedback |
Send feedback about one of a map's topics | No |
| GET | /api/khub/topic/styled-content |
Get a topic's styled content | No |
| POST | /api/khub/topics/search |
Search topics | No |
| GET | /api/khub/section/html |
Get the content of an HTML section | No |
| GET | /api/khub/documents |
List documents | No |
| GET | /api/khub/documents/{docId} |
Get a document's metadata | No |
| GET | /api/khub/documents/{docId}/content |
Get the content of a document | No |
| GET | /api/khub/documents/{docId}/content/text |
Get the content of a document as plain text | No |
| POST | /api/khub/documents/search |
Search documents | No |
| GET | /api/khub/documents/{docId}/rating |
Get a document's rating | No |
| POST | /api/khub/documents/{docId}/rating |
Rate a document | No |
| DELETE | /api/khub/documents/{docId}/rating |
Delete a document's rating | No |
| POST | /api/khub/maps/{docId}/feedback |
Send feedback about a document | No |
| GET | /api/khub/documents/{khubId}/attachments |
List attachments | No |
| GET | /api/khub/maps/{mapId}/attachments |
List map attachments | No |
| GET | api/khub/documents/{khubId}/attachments/{attachmentId}/content |
Download an attachment | No |
| GET | /api/khub/maps/{mapId}/attachments/{attachmentId}/content |
Download a map attachment | No |
| GET | /api/khub/locales |
Get locales for all content | No |
| POST | /api/khub/locales/search |
Get locales for filtered content | No |
| POST | /api/khub/clustered-search |
Clustered search | No |
| POST | /api/khub/suggest |
Suggest | No |
| POST | /api/khub/semantic/search |
Semantic search | No |
| POST | /api/khub/semantic/clustered-search |
Clustered semantic search | No |
| POST | /opensearch.xml |
OpenSearch | No |
| GET | /portal-asset/{alias} |
Get an asset | No |
Knowledge Hub web services for administrators
The web services in the following table can require the KHUB_ADMIN, PORTAL_ADMIN, or ADMIN role.
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| GET | /api/admin/khub/dataflow/reports |
List dataflow reports | Yes |
| GET | /api/admin/khub/dataflow/reports/{reportId} |
Get a dataflow report | Yes |
| GET | /api/khub/uploads/{uploadId}/report |
Get a publish report | Yes |
| PUT | /api/admin/khub/dataflow/reprocess |
Reprocess content | Yes |
| PUT | /api/admin/khub/dataflow/reindex |
Reindex content | Yes |
| GET | /api/admin/khub/sources |
List sources | Yes |
| GET | /api/admin/khub/sources/{sourceId} |
Get a source | Yes |
| PUT | /api/admin/khub/sources/{sourceId} |
Create a source | Yes |
| DELETE | /api/admin/khub/sources/{sourceId} |
Delete a source | Yes |
| POST | /api/admin/khub/sources/{sourceId}/upload |
Upload content | Yes |
| DELETE | /api/admin/khub/maps/{mapId} |
Delete a map | Yes |
| GET | /api/khub/maps/{mapId}/rights |
Get a map's access rights | No |
| DELETE | /api/admin/khub/documents/{docId} |
Delete an unstructured document | Yes |
| GET | /api/admin/khub/publications |
Get publications by metadata | Yes |
| PUT | /api/admin/khub/publications/update-metadata |
Update/replace publication metadata | Yes |
| DELETE | /api/admin/khub/publications |
Delete publications by metadata | Yes |
| GET | /api/khub/documents/{publicationId}/rights |
Get a publication's access rights | Yes |
| PUT | /api/admin/khub/documents/attachments |
Add or update attachments | Yes |
| PUT | /api/admin/khub/maps/attachments |
Add or update map attachments | Yes |
| DELETE | /api/admin/khub/documents/attachments |
Delete an attachment by khubId |
Yes |
| DELETE | /api/admin/khub/maps/attachments |
Delete a map attachment by khubId |
Yes |
| DELETE | /api/admin/khub/documents/attachments |
Delete an attachment by originId |
Yes |
| DELETE | /api/admin/khub/maps/attachments |
Delete a map attachment by originId |
Yes |
| GET | /api/admin/khub/vocabularies |
List vocabularies | Yes |
| POST | /api/admin/khub/vocabularies |
Create a vocabulary | Yes |
| PUT | /api/admin/khub/vocabularies/{vocabularyId} |
Update a vocabulary's configuration | Yes |
| PUT | /api/admin/khub/vocabularies/{vocabularyId}/content |
Update a vocabulary's content and structure | Yes |
| GET | /api/admin/khub/vocabularies/{vocabularyId}/content |
Download a vocabulary | Yes |
| DELETE | /api/admin/khub/vocabularies/{vocabularyId} |
Delete a vocabulary | Yes |
| PUT | /api/admin/khub/dita-ot |
Upload DITA-OT | Yes |
| GET | /api/admin/khub/dita-ot/content |
Download DITA-OT | Yes |
| DELETE | /api/admin/khub/dita-ot |
Delete DITA-OT | Yes |
| GET | /api/admin/khub/dita-ot |
Get DITA-OT metadata | Yes |
| GET | /api/admin/khub/dita-conf |
Get DITA-OT configuration | Yes |
| PUT | /api/admin/khub/dita-conf |
Update DITA-OT configuration | Yes |
| GET | /api/khub/packages |
List content packages | Yes |
| GET | /api/khub/packages/{packageId} |
Get a content package's metadata | Yes |
| DELETE | /api/khub/packages/{packageId} |
Delete a content package | Yes |
| POST | /api/khub/packages |
Create a content package | Yes |
| GET | /api/khub/packages/{packageId}/result.zip |
Download a content package archive | Yes |
| GET | /portal/custom-code/{filePath} |
Get a custom code file | Yes |
| GET | /api/admin/portal/custom-code |
List custom code files | Yes |
| POST | /api/admin/portal/custom-code |
Upload custom code files | Yes |
| DELETE | /api/admin/portal/custom-code/{filePath} |
Delete a custom code file | Yes |
| GET | /api/admin/portal/assets |
List assets | Yes |
| PUT | /api/admin/portal/assets/{alias} |
Update an asset's information | Yes |
| POST | /api/admin/portal/assets |
Upload assets | Yes |
| DELETE | /api/admin/portal/assets/{alias} |
Delete an asset | Yes |
Users
The web services in the following table require the USERS_ADMIN or ADMIN role. For some web services, users of any role can also get or set information about themselves.
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| GET | /api/users |
List users | Yes |
| POST | /api/users/search |
Search users | Yes |
| GET | /api/users/{userId} |
Get a user | Yes |
| GET | /api/users/{userId}/dump |
Get a user's personal information and assets | Yes |
| POST | /api/users/register |
Create a user | Yes |
| PUT | /api/users/{userId} |
Change a user's display name | Yes |
| PUT | /api/users/{userId}/password |
Change a user's password | Yes |
| DELETE | /api/users/{userId} |
Delete a user | Yes |
| GET | /api/users/{userId}/groups |
Get a user's groups | Yes |
| PUT | /api/users/{userId}/groups |
Set a user's groups | Yes |
| GET | /api/users/{userId}/roles |
Get a user's roles | Yes |
| PUT | /api/users/{userId}/roles |
Set a user's roles | Yes |
| GET | /api/users/{userId}/tags |
Get a user's tags | Yes |
| PUT | /api/users/{userId}/tags |
Set a user's tags | Yes |
| GET | /api/users/{userId}/bookmarks |
List bookmarks | Yes |
| DELETE | /api/users/{userId}/bookmarks |
Delete all bookmarks | Yes |
| POST | /api/users/{userId}/bookmarks |
Create a bookmark | Yes |
| PUT | /api/users/{userId}/bookmarks/{bookmarkId} |
Update a bookmark | Yes |
| DELETE | /api/users/{userId}/bookmarks/{bookmarkId} |
Delete a bookmark | Yes |
| GET | /api/users/{userId}/searches |
List searches | Yes |
| DELETE | /api/users/{userId}/searches |
Delete all searches | Yes |
| POST | /api/users/{userId}/searches |
Create a search | Yes |
| PUT | /api/users/{userId}/searches/{searchId} |
Update a search | Yes |
| DELETE | /api/users/{userId}/searches/{searchId} |
Delete a search | Yes |
| GET | /api/users/{userId}/collections |
List collections | Yes |
| DELETE | /api/users/{userId}/collections |
Delete all collections | Yes |
| POST | /api/users/{userId}/collections |
Create a static collection | Yes |
| POST | /api/users/{userId}/collections |
Create a swift collection | Yes |
| PUT | /api/users/{userId}/collections/{collectionId} |
Update a static collection | Yes |
| PUT | /api/users/{userId}/collections/{collectionId} |
Update a swift collection | Yes |
| DELETE | /api/users/{userId}/collections/{collectionId} |
Delete a collection | Yes |
| GET | /api/users/{userId}/collections/{collectionId}/documents |
List a collection's documents | Yes |
| POST | /api/users/{userId}/personal-books |
Create a personal book | Yes |
Authentication
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| POST | /api/authentication/login |
Sign in with credentials | Yes |
| GET | /api/authentication/current-session |
Get session information | Yes |
| POST | /api/authentication/logout |
Log out of a Fluid Topics portal | Yes |
| GET | /api/authentication/sso/{realmId}/login |
Authentication with SSO | Yes |
Languages
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| GET | /api/locales |
Get locale configuration | No |
| GET | /api/locales/default |
Get default locale configuration | No |
| POST | /api/locales/default |
Update default locale configuration | Yes |
Tenants
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| GET | /api/health |
Get a tenant health report | No |
| GET | /api/probe |
Get a front server health report | No |
Analytics
The web services in the following table require the ANALYTICS_USER or ADMIN role.
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| POST | /analytics/api/v2/khub/views-heatmap |
Content usage heatmap | Yes |
| POST | /analytics/api/v1/khub/time-report |
Content inventory | Yes |
| POST | /analytics/api/v2/documents/views-top |
Document views | Yes |
| POST | /analytics/api/v2/documents/{id}/topics/views-heatmap |
Document heatmap | Yes |
| POST | /analytics/api/v1/topics/views-top |
Topic views | Yes |
| POST | /analytics/api/v1/documents/ratings |
Document ratings | Yes |
| POST | /analytics/api/v1/topics/ratings |
Topic ratings | Yes |
| POST | /analytics/api/v1/traffic/user-activity |
User activity | Yes |
| POST | /analytics/api/v1/users/assets/time-report |
User assets | Yes |
| POST | /analytics/api/v1/traffic/event-counts |
Events count | Yes |
| POST | /analytics/api/v2/traffic/sessions |
Sessions | Yes |
| POST | /analytics/api/v1/traffic/sources/evolution |
Source evolution | Yes |
| POST | /analytics/api/v1/traffic/sources/detail |
Source details | Yes |
| POST | /analytics/api/v1/traffic/sources/destination |
Source destination | Yes |
| POST | /analytics/api/v2/traffic/internal-navigation |
Internal navigation | Yes |
| POST | /analytics/api/v1/traffic/page-views |
Page views | Yes |
| POST | /analytics/api/v2/traffic/api-calls |
API calls | Yes |
| POST | /analytics/api/v2/traffic/api-calls-heatmap |
API calls heatmap | Yes |
| GET | /analytics/api/v2/traffic/inventory/calling-apps |
Calling apps | Yes |
| POST | /analytics/api/v3/traffic/browsers-top |
Browsers | Yes |
| POST | /analytics/api/v3/traffic/countries-top |
Countries | Yes |
| GET | /analytics/api/v1/traffic/inventory/pages |
Pages | Yes |
| POST | /analytics/api/v1/traffic/devices-top |
Device types | Yes |
| POST | /analytics/api/v2/searches/facets-heatmap |
Most popular facets | Yes |
| POST | /analytics/api/v2/searches/terms-top |
Search terms | Yes |
| POST | /analytics/api/v2/searches/no-results-top |
Searches with no results | Yes |
| POST | /analytics/api/v1/events |
Retrieve events | Yes |
| GET | /analytics/api/v1/genai/inventory/profiles |
Generative AI profiles | Yes |
| POST | /analytics/api/v1/genai/profile-activity |
Profile activity | Yes |
Generative AI
The web services in the following table require the GENERATIVE_AI_USER or ADMIN role.
| Method | Endpoint | Title | Authentication |
|---|---|---|---|
| POST | /api/admin/ai/profiles |
Create a generative AI profile | Yes |
| GET | /api/admin/ai/profiles |
List generative AI profiles | Yes |
| GET | /api/admin/ai/profiles/{id} |
Get a generative AI profile | Yes |
| PUT | /api/admin/ai/profiles/{id} |
Change a generative AI profile | Yes |
| DELETE | /api/admin/ai/profiles/{id} |
Delete a generative AI profile | Yes |
| POST | /api/ai/generate |
Query a large language model (LLM) | No |
| POST | /api/ai/rag/chat |
Retrieval augmented generation (RAG) | No |
| POST | /api/ai/translate |
Translation | No |