. Create an API key under API keys.Guide
Conventions: IDs, time, paging, versions
Identifiers
Most objects have a ULID id: 26 characters, sortable by creation time (01JA5V6Q8M2H7G4K9P3T0R1S2X). Events have evt_ ids. Treat ids as opaque strings.
Time
Timestamps are Unix epoch milliseconds in UTC (created_at, scheduled_at, occurred_at). Days and months in reports and quotas follow the business time zone from GET /v1/profile where stated, otherwise UTC.
Money
Amounts are integers in the minor unit of their currency (cents); the Indonesian rupiah has no minor unit, so 150000 IDR is Rp150.000.
Pagination
- Cursor (message history, chats): a page returns
next_cursor; pass it ascursor(orbefore, as documented per endpoint) for the next, older page.nullmeans there is nothing more. - Offset (contacts and other lists):
limitandoffset.
Updates
PATCH and most PUT endpoints change only the fields you send; the reference says when a PUT replaces a whole list. Booleans are JSON true/false.
Language
Error texts follow X-Lang / ?lang= / Accept-Language (English or Indonesian). Some endpoints that produce text for people (summaries, previews, templates) take a lang field.
Versioning
This is version 1 (/v1). New fields and endpoints are added without notice — ignore fields you do not know. Breaking changes will come as /v2, with at least 6 months of both versions running side by side.
Sizes
A request body may be at most 10 MB, uploads included. Media sent from a url may be up to 25 MB (ChatKomodo downloads it); AI knowledge documents up to 8 MB.