API Source
An API Source pulls from a third-party REST API on a schedule and feeds the responses onto your surface like any other connection - no custom code.
Add one
Drag an API Source node onto the canvas (or ask Azi: "poll the GitHub stars API every minute") and open the Inspector.
Configure
| Setting | What it does |
|---|---|
| Endpoint | The URL to poll |
| Method | GET (default) or POST |
| Headers | Any request headers |
| Polling interval | How often to poll (ms) |
| Response mapping | A JSONPath to pull the data out of the response |
| Auth | None, Bearer, APIKey, or Basic (+ the matching credential) |
A public API needs no auth. Pause polling any time from the Inspector.
Verify
Incoming events appear in the Live Stream panel on each poll. Wire the API Source to a connection, then to a Surface, and the responses flow through like any feed.
Then
Crystallize a Warm Query over it. Want to feed data from your own service or a database instead of polling? That push-ingest path is on the roadmap - for now, expose it as an API the source can poll.