Follow an Import
helpcenter_get_importRead one import: its plan, what is chosen, and how a run is going — progress (articles created, updated, conflicts with edits made here, images copied and failed), the imported articles waiting for review, and error once a run stops. limit says how much room an unclaimed help center has left.
Follow a run with this until status is completed or failed; a run reads the source in the background, so allow a minute between checks.
Read-only.
Args:
import_id (number, required)
response_format ('markdown' | 'json'): default 'markdown'.
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. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |