NotulAIDevelopers

v1.1.0

Changelog and versioning

What changed, and what you are entitled to expect from the next change.

While this is alpha

Breaking changes are possible. Every one of them is announced to the administrators of each organisation with a live key before it ships, and appears here. That is the whole of the promise: the alpha label buys us the room to correct the contract while the first integrations are being built, and it costs you the guarantee that nothing will move.

Write clients that ignore fields they do not know. New fields, new enum values, new codes and new endpoints can arrive at any time, alpha or not, and are not announced.

Once the label comes off

The contract freezes. Within a version, nothing is renamed or removed and no existing case changes its status code. Anything that does disappear is announced at least six months ahead, by email to the administrators of every organisation with a live key, and the route carries a Deprecation header until it goes. A next version is offered alongside this one, never in place of it.

Entries

  1. Personal API keys

    A key can now also belong to a single user, created on their own account page. It authenticates the same way, acts as that user and never exceeds their own permissions and visibility. Enabled separately per organisation; when it is off, such a key answers 403 PERSONAL_API_KEYS_DISABLED. See Authentication for how the two kinds differ. Integration keys are unchanged.

  2. Meetings can be changed after they are created

    PATCH /v1/meetings/{meeting_id} changes a meeting's title, date, start time or project. Send only the fields you want to change. It needs meetings:write, works at any point in the meeting's life, and re-indexes the meeting for search when the title, the date or the project moves, which costs one credit once its minutes have been indexed.

  3. The API opens in alpha

    Eighteen endpoints, thirteen scopes, one error envelope. This portal and openapi.json are generated from the running contract.

The internal API is a different thing

The NotulAI web app talks to its own endpoints, which also live under /v1/ but on a different host. Those move with the app and carry none of the guarantees above. Everything on this portal is about api.notulai.nl.