Aimtell API

What authentication does the Aimtell API use?

An apiKey scheme. The key is sent as a header on each request. Through Jentic the key is held in the vault and never enters the agent's context.

Can I send a one-off push to a segment?

Yes. Build a segment with the segments endpoints, then POST /prod/push/ with the segment id and the message payload. Aimtell resolves the segment to subscribers and dispatches the push across browsers.

What are the rate limits for the Aimtell API?

The spec does not declare explicit rate limits. Most endpoints are scoped to a site id, so concurrency is naturally bounded by the number of sites; respect HTTP 429 responses if you push high volumes.

How do I run an event-triggered campaign through Jentic?

Run pip install jentic, search 'create an event-triggered push campaign', execute /prod/event-campaigns/ with the segment id and trigger event, and poll /prod/event-campaign/{id}/results to report performance. Run it through Jentic One, the self-hosted execution layer.

Can I push from an RSS feed automatically?

Yes. POST /prod/rss-notifications/ with the feed URL and the target site id. Aimtell polls the feed and pushes each new item to subscribers without further input.

Can I limit what my agent is allowed to do with the Aimtell API?

Yes. Because you run Jentic One yourself, your own rules decide which Aimtell operations and credentials the agent may use, so sending a push via POST /prod/push/ is only available if you add it. Since Aimtell carries campaign and notification ids in the URL path, such as /event-campaign/{id}/results and /rss-notification/{id}, you can pin the agent to a single campaign or notification rather than the whole account. That lets you allow read-only reporting while withholding the ability to create or update campaigns.