Skip to navigation

Content Sources

View as Markdown

tool.search.content-sources

A content source’s connector.auth_method must be CONSISTENT with the backing connector’s stored auth (the API does not reconcile them — a mismatch passes validation and fails deep as a 500).

  • Endpoint: /tool/search/content-sources | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/search/content-sourcesList content sources
POST/tool/search/content-sourcesCreate content source
GET/tool/search/content-sources/{id}Get content source
PATCH/tool/search/content-sources/{id}Update content source

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of the content source, assigned by the server. Cannot be changed.
namestring✅Display name of the content source. Required.
systemenumExternal system the content is ingested from, such as Box, Confluence, Google Drive, Jira, Outlook, SharePoint & OneDrive, Slack, ServiceNow, Unily, Zendesk or GitHub. Cannot be changed after creation. One of: EXTERNAL_SYSTEM_BOX, EXTERNAL_SYSTEM_SERVICE_NOW, EXTERNAL_SYSTEM_CONFLUENCE, EXTERNAL_SYSTEM_GDRIVE, EXTERNAL_SYSTEM_JIRA, EXTERNAL_SYSTEM_OUTLOOK, EXTERNAL_SYSTEM_SHAREPOINT_ONEDRIVE, EXTERNAL_SYSTEM_SLACK, … (11 values).
connector_selectionConnectorSelection✅The connector used to ingest the content and the connection method with its options. Required.
scopeScopeSelectionWhich containers in the source (for example knowledge bases, spaces, sites, drives, folders or categories) are ingested: all, only selected ones, or all except selected ones.
filter_conditionsFilterRulesOptional filters that include or exclude specific content from ingestion. All conditions must match.
url_overrideContentUrlOverrideOptional templates that rewrite the links to articles and attachments shown to users, for example to point to a custom portal.
audienceAudienceUsers who have access to this content: all users, selected users, or no users. Defaults to no users on create.
versionVersion✅Document version. On update, send back the num from your last read.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.

Example create body

{
"name": "servicenow_knowledge",
"system": "EXTERNAL_SYSTEM_SERVICE_NOW",
"connector_selection": {
"connector_id": "6f1c9f0e-6e1a-4b39-9a1e-1c6d0f2b7a55",
"servicenow_common_method": {
"add_knowledge_bases": true,
"live_search_enabled": false
}
},
"version": {
"change_description": "Initial version."
}
}