Scan a Knowledge Base to Import
helpcenter_scan_importRead a public Zendesk Guide, Intercom, Document360, Help Scout Docs, Front Knowledge Base or HelpDocs help center and answer what importing it would bring: its categories, articles and languages, and where each language lands here. Imports nothing yet.
The fastest way to fill the help center: scan, optionally choose with helpcenter_choose_import, run with helpcenter_run_import, follow with helpcenter_get_import. Every category and every language that can land here starts chosen.
The scan reads the remote help center, honouring its robots.txt, and the API gives it up to 40 seconds: longer than this call waits (25). If the call times out, the scan most likely carries on and saves its result: wait about 20 seconds and look for it with helpcenter_list_imports before scanning again, which would start it over. Scanning the same address again refreshes an import that has not run; scanning another address cancels an earlier one that never ran.
Refused for a source that needs signing in (needs_credentials): you cannot send a source's credentials, so file a migration request (helpcenter_request_migration) or ask the user to connect it from the dashboard. A platform the importer does not read comes back with importable: false; file a migration request for it.
Args:
url (string, required): the help center's address.
confirm_ownership (boolean, optional): true when the user owns that help center or may copy its content. Not needed while the help center is unclaimed; required once it is claimed.
Returns: { import: { id, platform, importable, status: "scanned", plan, selection, limit, ... } }. Keep the id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The address of the help center to import: a public Zendesk Guide, Intercom, Document360, Help Scout Docs, Front Knowledge Base or HelpDocs help center (the scheme is optional). | |
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| confirm_ownership | No | true: the user owns this help center or may copy its content. Not needed while the help center is unclaimed; required once it has been claimed. Only send it when the user has said so. |