🛠️ How-to guide · Last updated: October 1, 2026

<aside> 📤

WHAT IT DOES

API Push lets your own systems — a CRM, a CMS, a work-order tool — send content straight into Zammo whenever it changes. Each record keeps its own ID, so pushing it again updates the same entry instead of creating a copy.

</aside>

When to use it

Use it when another system already knows the moment something changes and can send it on — a new road closure, an updated FAQ, a revised policy document. There is nothing to schedule: content arrives when your system pushes it. If you would rather Zammo fetch from your system's API on a schedule, use Add a source: API Crawl.

Before you start

• A workspace API key. Only workspace Admins can generate keys (see Roles & Permissions).
• Someone who can set up the sending side — a developer or an integration tool that can make HTTPS requests.
• (Optional) the IDs of the Knowledge Bases the content should land in.

Step 1 — Generate an API key

1. Open Workspace → Settings → API Keys, and select Generate key.
2. Give the key a Key name — name it after the system that will hold it, so you know what to revoke later.
3. Choose an Expiry, or leave it as Never expires.
4. Select Generate API key, then copy the key. It is shown only once.

Generating a workspace API key: name it after the system that will use it, generate it, and copy the key and the ready-made example. The key is shown only once.

<aside> ⚠️

Store the key in the sending system's secret store, never in a shared document or email. If a key leaks, revoke it from the API Keys list — systems using it stop working immediately.

</aside>

Step 2 — Push content

Open Sources → Add source → API Push for ready-to-copy examples. Your system sends content in one of two ways, using the key as a bearer token (Authorization: Bearer <key>):

• JSON records — POST <https://agents.zammo.ai/api/v1/push/content>, up to 100 records per request, each with an externalId (its stable ID), a name, and the content. Optional per record: tags, a format, a sourceUri, and knowledgeBaseIds to add it straight to knowledge bases.
• Files — POST <https://agents.zammo.ai/api/v1/push/files>, up to 20 documents per request, in the same file types as Add a source: Upload files.

The API Push card under Add source: the three setup steps, a shortcut to manage API keys, and copy-ready examples for pushing JSON records and files to agents.zammo.ai.