Koltrix logoKoltrixDocs
Reference

API reference

A JSON REST API. Pick an endpoint to see its parameters, copy a request in your language, and try it with your own key.

Base URL
https://api.koltrix.com/api/v2
Authentication
Authorization: Bearer kx_… API keys and scopes
Limits
60 requests a minute per key. Limits
Errors
JSON with an error string. Every error

Download OpenAPIJSONGive this to an AI assistant

Transactional email

Send one email to one or more recipients. Requires the send scope. Pass an Idempotency-Key header so a retry can never send twice.

Messages

Your outbound message log: every message sent through the API, the SMTP relay and broadcasts, one record per recipient. Requires the read or send scope.

Your key

Check which workspace an API key belongs to and which scopes it has, and read its domains, usage and templates.

Agent mailboxes

Give an AI agent or workflow its own address on your domain. Create the mailbox and its key in the Koltrix app (Agents). A key made for one agent mailbox can call only these endpoints, and only for that mailbox: use me as the id. Everything an agent reads is wrapped as untrusted data, and a message the injection shield rates high risk is withheld. What an agent may send depends on the mailbox's autonomy level: suggest saves a draft, approve asks a person in the Action center, and auto sends only inside the rules you set (allowed recipients, daily cap, quiet hours) and never while the kill switch is on.

Lists

Newsletter audiences, available over the API only for now. Reading needs read or newsletter; changes need newsletter.

Subscribers

The people on a list. Reading needs read or newsletter; changes need newsletter.

Broadcasts

Send one message to every active subscriber on a list. Requires the newsletter scope.

Sequences

Timed series of emails sent to people who join a list. Reading needs read or newsletter; changes need newsletter.

34 endpoints. Spot a missing one? Email [email protected].