Integration profile
Knowledge source · Generic knowledge API
Index articles and attachments from a governed REST API with explicit paging and mappings.
Demo baseline · November 13, 2026Prerequisites
- Stable API endpoint
- Read-only API identity
- Document and attachment response examples
Configuration steps
- Configure authentication and paging
- Map article and attachment fields
- Validate preview before indexing
Provider fields
| Field | Type | Requirement and options |
|---|---|---|
Authentication schemeauthScheme | select | Requiredoauth2_client_credentials, bearer_token, api_key, basic, mtls, none |
OAuth token URLtokenUrl | url | Optional |
OAuth client IDclientId | text | Optional |
Article endpoint patharticlePath | text | Required |
Attachment endpoint pathattachmentPath | text | Optional |
Paginationpagination | select | Requirednone, page_number, offset_limit, cursor, link_header |
Article response mappingarticleMapping | textarea | Required |
Attachment response mappingattachmentMapping | textarea | Optional |
Verify and troubleshoot
Test with the narrowest supported non-production scope. Confirm that the connection test reaches the expected provider and that the preview or receipt matches the intended scope. Check identity, credential references, network access and provider permissions before retrying. Record the failure stage and redact sensitive payloads when escalating.