Skip to content

For the complete documentation index, see llms.txt. Markdown versions are available by appending .md to documentation page URLs. Read the agent handbook.

Zortex Docs
Start searching Install Vision
Sync your sources

Sync your sources

Collect supported source records, inspect progress, and continue an incomplete pass.

On this page

Sync collects supported information into the Vault so it can be searched later. A live connector Action does not require a historical sync. If you only need one current item, start with a bounded read.

Full collection is available for selected sources, not every app in the connector directory. Installed versions, account permissions, and provider limits determine the actual scope.

Check progress before starting another run

Open the local product:

Shell
indra web --root "/absolute/path/to/your/Vault"

In Apps, open the source and inspect Full sync. The details distinguish:

Field Meaning
Status Running, waiting, stopped, not connected, or not syncing.
Records in Vault Stored full-sync rows; revisions can contribute more than one row.
First full read Whether a pass has reached the source's reported end.
Current pass Whether it finished or will continue from a saved position.
Next run The scheduler's known time, provider backoff, or an explicit unavailable schedule.
Last error The latest reported error, including whether a later state cleared it.

For terminal inspection:

Shell
indra --root "/absolute/path/to/your/Vault" status

An active run with increasing progress should keep its existing owner. Avoid competing manual runs simply because a page has not refreshed yet.

Run a supported sync explicitly

For example, to collect a connected Gmail source:

Shell
indra --root "/absolute/path/to/your/Vault" sync --source gmail --request-id gmail-import-1

The MCP form is:

JSON
{
  "name": "connector.sync",
  "params": {
    "source": "gmail",
    "requestId": "gmail-import-1"
  }
}

Pass that object to indra.action. Use a descriptive request ID for the operation and retain the returned receipt. If an account-specific bindingId is required, use the identity returned by the installed product; do not guess one.

A result with complete:false has not reached the end. The sync path saves its cursor; a subsequent supported run continues collection. If a request ID returns an existing receipt, inspect it instead of treating it as a new run. A timeout or error needs status and recovery before retry.

Automatic collection

Where enabled, the resident schedules supported connected sources. A bounded run saves progress; completed passes are followed by incremental passes. Provider throttling, authorization failures, and cleanup problems can postpone another run. Use the actual reported state instead of promising an exact completion time.

To launch without automatic full sync, set ZORTEX_AUTO_SYNC=0 before starting the host, web app, MCP, or onboarding. This setting does not disable an explicit sync command.

The setting applies to a process and its generated launcher. It does not change an already running host, and reinstalling does not necessarily overwrite a preserved Codex catalog. Permissions and source controls explains how to apply the setting consistently.

Verify what was collected

After completion, search a small sample:

Shell
indra --root "/absolute/path/to/your/Vault" search --json '{"sql":"SELECT id,source,source_id,title FROM z_records WHERE source = ? LIMIT 10","params":["gmail"]}'

Check that the account, content types, dates, and completion state meet your task. Large mailboxes, protected Drive objects, missing bodies, or provider limits can leave explicit gaps. A growing row count or one returned record does not prove full account coverage.

If an agent was collecting data to answer a question, it should now answer that question with the relevant records; “sync complete” is only an intermediate result.

Suggested