🛠️ How-to guide · Last updated: October 1, 2026
<aside>
🔄
WHAT IT DOES
API Crawl turns records from your own system's REST API into knowledge your agents answer from. Point Zammo at an endpoint, say which fields matter, and it keeps the content in sync on a schedule — adding new records, updating changed ones, and removing ones that are gone.
</aside>
When to use it
Use it when the answer lives in a system that has an API — a facilities list, a product catalog, an events calendar, a service directory — and you want agents to answer from the live records rather than a one-off export. If your system would rather send content to Zammo whenever something changes, use Add a source: API Push instead.
Before you start
- Access: Editor, Content Manager, Publisher, or Admin (see Roles & Permissions).
- API Crawl is a paid-plan feature — on other plans, choosing it shows an upgrade prompt.
- A public https endpoint. Zammo calls it directly, so private or internal addresses are refused.
- The endpoint's credential, if it needs one (an API key, a token, a username and password, or OAuth2 details).
- (Optional, saves the most time) the API's OpenAPI (Swagger) description, as a link or as JSON you can paste.
Step by step
Import the endpoint
- Open Sources → Add source → API Crawl, and give the source a Name.
- Select Import from OpenAPI, enter the link to the API's description, and select Read document. (No description? Fill in the Endpoint URL and Authentication by hand and go to Finish the setup.)
- Choose the endpoint to read from — endpoints that return a list are the ones that hold records.
- Confirm what gets read: tick the Options to send, then select Use this endpoint. The address, the authentication method, and a first mapping are filled in for you.
Importing an API Crawl from OpenAPI: open Add source → API Crawl, read the Riverton Parks & Recreation API's description, pick the facilities endpoint, and the fields are mapped for you.
Finish the setup
- Under Authentication, add the key or secret. It is stored encrypted and never shown again.
- Under Response, check What each field becomes (see below). Select Load the response to map against what the API returns today.