Skip to navigation
Snapshot APISnapshot API

Export the Agent configuration as a downloadable archive

Builds the export in the background and returns a job_id immediately. Poll GET /v2/config/jobs/{job_id} until the status is completed, then take the temporary download link from the result.

That result also carries secrets: the Agent’s client-secret names, each null. Secret values never leave the source Agent, so this is the list the target will need — fill it in and send it as the import request’s secrets. No download required.

The export is a single timestamped archive, e.g. config_20260806-143235.tar.gz. Unpack it to get:

  • config.json — the full configuration document, covering the AI Agent persona, variables, actions, handoffs, processes, greetings, v2 generative playbooks, coaching, custom instructions, glossary, knowledge sources, CSAT settings, your custom regex redactions, the image redaction setting (Ada’s built-in PII redaction switches are not part of a snapshot), and the enabled action-integration id list.
  • articles/ — the knowledge articles as JSON Lines, one article per line, partitioned by a hash of their external_id across articles_*.jsonl files so no single file has to be read whole.
  • manifest.json — an index of the above, including the article count and the partitioning scheme. It also carries available, how many articles the Agent has.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Export accepted for async processing. Poll the returned job_id at GET /v2/config/jobs/{job_id} for the status and the archive’s temporary download link.

job_idstring
The id to poll for the job status and result
statusenum

queued for a newly accepted job. An export submitted while one is already running for the Agent returns that job instead of starting a second, so its status may already be in_progress — poll the job_id either way.

Allowed values:

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error