Run an Import
helpcenter_run_importStart an import now, with what is chosen, or run a finished or failed one again. The run reads the source in the background: follow it with helpcenter_get_import until status is completed or failed.
Running again updates the articles it brought before and never adds them twice; an article edited here since is kept as it is and flagged for review. While the help center is unclaimed, a run that would take it past its 500 articles is refused (limit_reached).
Args:
import_id (number, required)
Returns: { import } with status queued or running.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| import_id | Yes | The import's id, from helpcenter_scan_import or helpcenter_list_imports. |